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

2025/03/06 • 6 new, 88 updated methods

MSIXPackages_List (new)
Description List MSIX packages in hostpool.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MSIXPackages_Get (new)
Description Get a msixpackage.
Reference Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
msixPackageFullName: string ,
}

⚐ Response (200)

{
properties:
{
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MsixPackages_CreateOrUpdate (new)
Description Create or update a MSIX package.
Reference Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
msixPackageFullName: string ,
msixPackage:
{
properties:
{
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
}
,
}

⚐ Response (201)

{
properties:
{
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MsixPackages_Update (new)
Description Update an MSIX Package.
Reference Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
msixPackageFullName: string ,
msixPackage:
{
properties:
{
isActive: boolean ,
isRegularRegistration: boolean ,
displayName: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MsixPackages_Delete (new)
Description Remove an MSIX Package.
Reference Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/msixPackages/{msixPackageFullName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
msixPackageFullName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHosts_RetryProvisioning (new)
Description A synchronous resource action that returns no content.
Reference Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/retryProvisioning
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Operations_List (updated)
Description List the operations for the provider
Reference Link ¶

⚶ Changes

{
  "#id": "Operations_List",
  "Description": {
    "new": "List the operations for the provider",
    "old": "List all of the available operations the Desktop Virtualization resource provider supports."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "A list of REST API operations supported by an Azure Resource Provider. It contains an URL link to get the next set of results.",
        "old": "Result of the request to list operations."
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ResourceProviderOperation items on this page",
            "old": "List of operations supported by this resource provider."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_9280929618f847deac4471cf88ecf253": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_9e0dfe16dae3407fa5abaeea020a623d": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_3d13142bded54f5e836350ca64df7c92": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /providers/Microsoft.DesktopVirtualization/operations
{
api-version: string ,
}

⚐ Response (200)

{
value:
[
{
name: string ,
display:
{
provider: string ,
resource: string ,
operation: string ,
description: string ,
}
,
isDataAction: boolean ,
properties:
{
serviceSpecification:
{
logSpecifications:
[
{
name: string ,
displayName: string ,
blobDuration: string ,
}
,
]
,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "AppAttachPackage_ListBySubscription",
  "$parameters": [
    {
      "#name": "$filter",
      "Description": {
        "new": "OData filter expression. Valid properties for filtering are package name, host pool, and resource group.",
        "old": "OData filter expression. Valid properties for filtering are package name, resource group, host pool, package owner name, and custom data."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The AppAttachPackage items on this page",
            "old": "List of App Attach Package definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Succeeded",
                        "Provisioning Successful"
                      ],
                      [
                        "Provisioning",
                        "Provisioning in Progress"
                      ],
                      [
                        "Failed",
                        "Provisioning Failed"
                      ],
                      [
                        "Canceled",
                        "Provisioning was Canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Provisioning",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "image": [
                    {
                      "#name": "imagePath",
                      "Description": {
                        "new": "VHD/CIM image path on Network Share.",
                        "old": "VHD/CIM/APP-V image path on Network Share."
                      }
                    },
                    {
                      "#name": "packageName",
                      "Description": {
                        "new": "Package Name from appxmanifest.xml.",
                        "old": "Package Name from appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageFamilyName",
                      "Description": {
                        "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                        "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageFullName",
                      "Description": {
                        "new": "Package Full Name from appxmanifest.xml.",
                        "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "displayName",
                      "Description": {
                        "new": "User friendly Name to be displayed in the portal.",
                        "old": "User friendly Name to be displayed in the portal. "
                      }
                    },
                    {
                      "#name": "packageRelativePath",
                      "Description": {
                        "new": "Relative Path to the package inside the image.",
                        "old": "Relative Path to the package inside the image. "
                      }
                    },
                    {
                      "#name": "isActive",
                      "Description": {
                        "new": "Make this version of the package the active one across the hostpool.",
                        "old": "Make this version of the package the active one across the hostpool. "
                      }
                    },
                    {
                      "#name": "packageDependencies",
                      "Description": {
                        "new": "List of package dependencies.",
                        "old": "List of package dependencies. "
                      },
                      "$items": {
                        "$properties": [
                          {
                            "#name": "dependencyName",
                            "Description": {
                              "new": "Name of package dependency.",
                              "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                            }
                          }
                        ]
                      }
                    },
                    {
                      "#name": "version",
                      "Description": {
                        "new": "Package version found in the appxmanifest.xml.",
                        "old": "Package Version found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "lastUpdated",
                      "Description": {
                        "new": "Date Package was last updated, found in the appxmanifest.xml.",
                        "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageApplications",
                      "Description": {
                        "new": "List of package applications.",
                        "old": "List of package applications. "
                      }
                    },
                    {
                      "#name": "certificateName",
                      "Description": {
                        "new": "Certificate name found in the appxmanifest.xml.",
                        "old": "Certificate name found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "certificateExpiry",
                      "Description": {
                        "new": "Date certificate expires, found in the appxmanifest.xml.",
                        "old": "Date certificate expires, found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "isPackageTimestamped",
                      "Enum": {
                        "new": [
                          [
                            "Timestamped",
                            "Package is timestamped"
                          ],
                          [
                            "NotTimestamped",
                            "Package is not timestamped, use certificate expiry date"
                          ]
                        ],
                        "old": [
                          [
                            "Timestamped",
                            ""
                          ],
                          [
                            "NotTimestamped",
                            ""
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "keyVaultURL",
                  "Description": {
                    "new": "URL path to certificate name located in keyVault",
                    "old": "URL of keyvault location to store certificate"
                  }
                },
                {
                  "#name": "failHealthCheckOnStagingFailure",
                  "Enum": {
                    "new": [
                      [
                        "Unhealthy",
                        "Health Check will report unhealthy"
                      ],
                      [
                        "NeedsAssistance",
                        "Health Check will report NeedsAssistance"
                      ],
                      [
                        "DoNotFail",
                        "Health Check will not report failure"
                      ]
                    ],
                    "old": [
                      [
                        "Unhealthy",
                        ""
                      ],
                      [
                        "NeedsAssistance",
                        ""
                      ],
                      [
                        "DoNotFail",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/appAttachPackages
{
api-version: string ,
subscriptionId: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ApplicationGroups_ListBySubscription (updated)
Description List applicationGroups in subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "ApplicationGroups_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ApplicationGroup items on this page",
            "old": "List of ApplicationGroup definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "applicationGroupType",
                  "Enum": {
                    "new": [
                      [
                        "RemoteApp",
                        "Application group is Remote and can launch individual applications without a Desktop."
                      ],
                      [
                        "Desktop",
                        "Application Group delivers a full expected Desktop experience"
                      ]
                    ],
                    "old": [
                      [
                        "RemoteApp",
                        ""
                      ],
                      [
                        "Desktop",
                        ""
                      ]
                    ]
                  }
                }
              ],
              "@added_1e33fb30062a4e0e98a2b30ba3943fdf": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_ec81a01cb640406a973b2e926f7860b7": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_4dd357df09974e2090970b8c31619bb0": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_c0f5e8625e5d4fe6b2ab0f52bfdf03c8": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_42699c135fcb45739c5355a13d359613": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_a839560a10a84bc9bba45448c5e49899": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_874fefa0cdab4772aede965cad217dc7": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_08291148b34c4c0a9e0a9c0784ea8050": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f8db17ae6b084100956cd433844c0675": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version: string ,
subscriptionId: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_List (updated)
Description List hostPools in subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The HostPool items on this page",
            "old": "List of HostPool definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "personalDesktopAssignmentType",
                  "Enum": {
                    "new": [
                      [
                        "Automatic",
                        "Automatically assigns an available personal desktop to the user."
                      ],
                      [
                        "Direct",
                        "Manually assigns a specific personal desktop to the user."
                      ]
                    ],
                    "old": [
                      [
                        "Automatic",
                        ""
                      ],
                      [
                        "Direct",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "loadBalancerType",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Uses BreadthFirst algorithm for load balancing."
                      ],
                      [
                        "DepthFirst",
                        "Uses DepthFirst algorithm for load balancing."
                      ],
                      [
                        "Persistent",
                        "Maintains persistent connections."
                      ],
                      [
                        "MultiplePersistent",
                        "Maintains multiple persistents connections."
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ],
                      [
                        "Persistent",
                        ""
                      ],
                      [
                        "MultiplePersistent",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "registrationInfo",
                  "Description": {
                    "new": "The registration info of HostPool.",
                    "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
                  },
                  "$properties": [
                    {
                      "#name": "registrationTokenOperation",
                      "Enum": {
                        "new": [
                          [
                            "Delete",
                            "Delete operation"
                          ],
                          [
                            "None",
                            "No Operation"
                          ],
                          [
                            "Update",
                            "Update Operation"
                          ]
                        ],
                        "old": [
                          [
                            "Delete",
                            ""
                          ],
                          [
                            "None",
                            ""
                          ],
                          [
                            "Update",
                            ""
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "ssoSecretType",
                  "Enum": {
                    "new": [
                      [
                        "SharedKey",
                        "The SSO Secret is a Shared Key."
                      ],
                      [
                        "Certificate",
                        "The SSO Secret is a Certificate."
                      ],
                      [
                        "SharedKeyInKeyVault",
                        "The SSO Secret is a SharedKey that is stored in KeyVault."
                      ],
                      [
                        "CertificateInKeyVault",
                        "The SSO Secret is a Certificate that is stored in KeyVault."
                      ]
                    ],
                    "old": [
                      [
                        "SharedKey",
                        ""
                      ],
                      [
                        "Certificate",
                        ""
                      ],
                      [
                        "SharedKeyInKeyVault",
                        ""
                      ],
                      [
                        "CertificateInKeyVault",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "preferredAppGroupType",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "Internal Use Only"
                      ],
                      [
                        "Desktop",
                        "Use Desktop Application Group"
                      ],
                      [
                        "RailApplications",
                        "Use RailApplications (RemoteApp)"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        "This value is read only, it is not accepted on input."
                      ],
                      [
                        "Desktop",
                        "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                      ],
                      [
                        "RailApplications",
                        "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                      ]
                    ]
                  }
                },
                {
                  "#name": "publicNetworkAccess",
                  "Enum": {
                    "new": [
                      [
                        "Enabled",
                        "Allows this resource to be accessed from the public network"
                      ],
                      [
                        "Disabled",
                        "Prevents this resource from being accessed from the public network"
                      ],
                      [
                        "EnabledForSessionHostsOnly",
                        "Allows SessionHosts to be accessed from the public network"
                      ],
                      [
                        "EnabledForClientsOnly",
                        "Allows Clients to be accessed from the public network"
                      ]
                    ],
                    "old": [
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ],
                      [
                        "EnabledForSessionHostsOnly",
                        ""
                      ],
                      [
                        "EnabledForClientsOnly",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "privateEndpointConnections": {
                    "$properties": {
                      "properties": [
                        {
                          "privateLinkServiceConnectionState": [
                            {
                              "#name": "status",
                              "Enum": {
                                "new": [
                                  [
                                    "Pending",
                                    "Connection is Pending"
                                  ],
                                  [
                                    "Approved",
                                    "Connection was Approved"
                                  ],
                                  [
                                    "Rejected",
                                    "Connection was rejected"
                                  ]
                                ],
                                "old": [
                                  [
                                    "Pending",
                                    ""
                                  ],
                                  [
                                    "Approved",
                                    ""
                                  ],
                                  [
                                    "Rejected",
                                    ""
                                  ]
                                ]
                              }
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Succeeded",
                                "Provisioning was successful"
                              ],
                              [
                                "Creating",
                                "A PrivateEndpointConnection is being created"
                              ],
                              [
                                "Deleting",
                                "A PrivateEndpointConnection is being deleted"
                              ],
                              [
                                "Failed",
                                "Provisioning failed"
                              ]
                            ],
                            "old": [
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                },
                {
                  "#name": "managedPrivateUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "directUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "publicUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "relayUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementType",
                  "Enum": {
                    "new": [
                      [
                        "Automated",
                        "Automated management of the hostpool"
                      ],
                      [
                        "Standard",
                        "Standard management of the hostpool"
                      ]
                    ],
                    "old": [
                      [
                        "Automated",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ]
                    ]
                  }
                }
              ],
              "@added_93e6da1c8d954fde893fe52e22997dc2": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_f316450efce64261af92c4d5ff01f8f0": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_0787e25ace4f4fe8b04d2a9e1e8b452d": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_5f2a430b2ab9428aa7b9da3d8961c3de": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_a3599d1f2a714020bdb3406d6f2bf5ea": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_3264ae099b5a4cce9804273696cdbfd1": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f7b68a1b6aa24ef1a285e0d23deb4294": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_e5ed833dcfb14f1588a3004d5c8196a7": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_6a3784fbe5244fd49726c4e54a066716": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version: string ,
subscriptionId: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_ListBySubscription (updated)
Description List scaling plans in subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ScalingPlan items on this page",
            "old": "List of scaling plan definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "schedules",
                  "Description": {
                    "new": "List of ScalingPlanPooledSchedule definitions.",
                    "old": "List of Pooled ScalingSchedule definitions."
                  },
                  "$items": {
                    "$properties": [
                      {
                        "daysOfWeek": {
                          "Description": {
                            "new": "Day of the week. Modeled as string",
                            "old": "Day of the week."
                          },
                          "Enum": {
                            "new": [
                              [
                                "Monday",
                                ""
                              ],
                              [
                                "Tuesday",
                                ""
                              ],
                              [
                                "Wednesday",
                                ""
                              ],
                              [
                                "Thursday",
                                ""
                              ],
                              [
                                "Friday",
                                ""
                              ],
                              [
                                "Saturday",
                                ""
                              ],
                              [
                                "Sunday",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Sunday",
                                ""
                              ],
                              [
                                "Monday",
                                ""
                              ],
                              [
                                "Tuesday",
                                ""
                              ],
                              [
                                "Wednesday",
                                ""
                              ],
                              [
                                "Thursday",
                                ""
                              ],
                              [
                                "Friday",
                                ""
                              ],
                              [
                                "Saturday",
                                ""
                              ]
                            ]
                          }
                        }
                      },
                      {
                        "#name": "rampUpLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "peakLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "rampDownLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "rampDownStopHostsWhen",
                        "Enum": {
                          "new": [
                            [
                              "ZeroSessions",
                              "Zero Total Sessions"
                            ],
                            [
                              "ZeroActiveSessions",
                              "Zero Active Sessions"
                            ]
                          ],
                          "old": [
                            [
                              "ZeroSessions",
                              ""
                            ],
                            [
                              "ZeroActiveSessions",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "offPeakLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              ],
              "@added_9f1008fdbf7c4ed0958d67a2e4b15642": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_9bfbd783fae142d4a45a9433ed53fc29": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_00f18ff6b59943e8bd094b19288cc48c": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_22a55df5628444ed8cf8e5c07923d3d9": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_753ce9ba557141a89604d1fa6cd6e6f6": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_519d8f49b6844c1e8d41d5f6cf8e18f7": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_a286fea0d6614247ac994b64598420ec": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_4895eeecbbf8412eab43758a5b2b3f62": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_30f70a7efa0f469f99988ec2b7daadac": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/scalingPlans
{
api-version: string ,
subscriptionId: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Workspaces_ListBySubscription (updated)
Description List workspaces in subscription.
Reference Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListBySubscription",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Workspace items on this page",
            "old": "List of Workspace definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "publicNetworkAccess",
                  "Enum": {
                    "new": [
                      [
                        "Enabled",
                        "This resource is accessible from the public network."
                      ],
                      [
                        "Disabled",
                        "This resource is not accessible from the public network."
                      ]
                    ],
                    "old": [
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "privateEndpointConnections": {
                    "$properties": {
                      "properties": [
                        {
                          "privateLinkServiceConnectionState": [
                            {
                              "#name": "status",
                              "Enum": {
                                "new": [
                                  [
                                    "Pending",
                                    "Connection is Pending"
                                  ],
                                  [
                                    "Approved",
                                    "Connection was Approved"
                                  ],
                                  [
                                    "Rejected",
                                    "Connection was rejected"
                                  ]
                                ],
                                "old": [
                                  [
                                    "Pending",
                                    ""
                                  ],
                                  [
                                    "Approved",
                                    ""
                                  ],
                                  [
                                    "Rejected",
                                    ""
                                  ]
                                ]
                              }
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Succeeded",
                                "Provisioning was successful"
                              ],
                              [
                                "Creating",
                                "A PrivateEndpointConnection is being created"
                              ],
                              [
                                "Deleting",
                                "A PrivateEndpointConnection is being deleted"
                              ],
                              [
                                "Failed",
                                "Provisioning failed"
                              ]
                            ],
                            "old": [
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                }
              ],
              "@added_c4cbb226acbe4f6980128a78d9ad6901": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_48aaf4b3e2a94ea79fd81d5881ae99a6": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_5fc6c8e49e7f44db8fe2659d9e56d30d": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_7b8fa1576d994d17a8e8bc4b4bc6c4e1": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_d374d00e742d4df3b058a6600ec58ee8": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_e4cff9bbd13d4f39994ad62cfe4ac13a": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_59fe2120d4d64a24b9d3ab93c6e7304f": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_6a53c1a89ceb4e34b6ef23b3b9f04e86": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_da4d7677043b4727ab6bb4e255055582": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version: string ,
subscriptionId: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "AppAttachPackage_ListByResourceGroup",
  "$parameters": [
    {
      "#name": "$filter",
      "Description": {
        "new": "OData filter expression. Valid properties for filtering are package name and host pool.",
        "old": "OData filter expression. Valid properties for filtering are package name, host pool, package owner name, and custom data."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The AppAttachPackage items on this page",
            "old": "List of App Attach Package definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Succeeded",
                        "Provisioning Successful"
                      ],
                      [
                        "Provisioning",
                        "Provisioning in Progress"
                      ],
                      [
                        "Failed",
                        "Provisioning Failed"
                      ],
                      [
                        "Canceled",
                        "Provisioning was Canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Provisioning",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "image": [
                    {
                      "#name": "imagePath",
                      "Description": {
                        "new": "VHD/CIM image path on Network Share.",
                        "old": "VHD/CIM/APP-V image path on Network Share."
                      }
                    },
                    {
                      "#name": "packageName",
                      "Description": {
                        "new": "Package Name from appxmanifest.xml.",
                        "old": "Package Name from appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageFamilyName",
                      "Description": {
                        "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                        "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageFullName",
                      "Description": {
                        "new": "Package Full Name from appxmanifest.xml.",
                        "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "displayName",
                      "Description": {
                        "new": "User friendly Name to be displayed in the portal.",
                        "old": "User friendly Name to be displayed in the portal. "
                      }
                    },
                    {
                      "#name": "packageRelativePath",
                      "Description": {
                        "new": "Relative Path to the package inside the image.",
                        "old": "Relative Path to the package inside the image. "
                      }
                    },
                    {
                      "#name": "isActive",
                      "Description": {
                        "new": "Make this version of the package the active one across the hostpool.",
                        "old": "Make this version of the package the active one across the hostpool. "
                      }
                    },
                    {
                      "#name": "packageDependencies",
                      "Description": {
                        "new": "List of package dependencies.",
                        "old": "List of package dependencies. "
                      },
                      "$items": {
                        "$properties": [
                          {
                            "#name": "dependencyName",
                            "Description": {
                              "new": "Name of package dependency.",
                              "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                            }
                          }
                        ]
                      }
                    },
                    {
                      "#name": "version",
                      "Description": {
                        "new": "Package version found in the appxmanifest.xml.",
                        "old": "Package Version found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "lastUpdated",
                      "Description": {
                        "new": "Date Package was last updated, found in the appxmanifest.xml.",
                        "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageApplications",
                      "Description": {
                        "new": "List of package applications.",
                        "old": "List of package applications. "
                      }
                    },
                    {
                      "#name": "certificateName",
                      "Description": {
                        "new": "Certificate name found in the appxmanifest.xml.",
                        "old": "Certificate name found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "certificateExpiry",
                      "Description": {
                        "new": "Date certificate expires, found in the appxmanifest.xml.",
                        "old": "Date certificate expires, found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "isPackageTimestamped",
                      "Enum": {
                        "new": [
                          [
                            "Timestamped",
                            "Package is timestamped"
                          ],
                          [
                            "NotTimestamped",
                            "Package is not timestamped, use certificate expiry date"
                          ]
                        ],
                        "old": [
                          [
                            "Timestamped",
                            ""
                          ],
                          [
                            "NotTimestamped",
                            ""
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "keyVaultURL",
                  "Description": {
                    "new": "URL path to certificate name located in keyVault",
                    "old": "URL of keyvault location to store certificate"
                  }
                },
                {
                  "#name": "failHealthCheckOnStagingFailure",
                  "Enum": {
                    "new": [
                      [
                        "Unhealthy",
                        "Health Check will report unhealthy"
                      ],
                      [
                        "NeedsAssistance",
                        "Health Check will report NeedsAssistance"
                      ],
                      [
                        "DoNotFail",
                        "Health Check will not report failure"
                      ]
                    ],
                    "old": [
                      [
                        "Unhealthy",
                        ""
                      ],
                      [
                        "NeedsAssistance",
                        ""
                      ],
                      [
                        "DoNotFail",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
$filter: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AppAttachPackage_Get (updated)
Description Get an app attach package.
Reference Link ¶

⚶ Changes

{
  "#id": "AppAttachPackage_Get",
  "$parameters": [
    {
      "#name": "appAttachPackageName",
      "Description": {
        "new": "The name of the App Attach package",
        "old": "The name of the App Attach package arm object"
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Succeeded",
                  "Provisioning Successful"
                ],
                [
                  "Provisioning",
                  "Provisioning in Progress"
                ],
                [
                  "Failed",
                  "Provisioning Failed"
                ],
                [
                  "Canceled",
                  "Provisioning was Canceled"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ]
              ]
            }
          },
          {
            "image": [
              {
                "#name": "imagePath",
                "Description": {
                  "new": "VHD/CIM image path on Network Share.",
                  "old": "VHD/CIM/APP-V image path on Network Share."
                }
              },
              {
                "#name": "packageName",
                "Description": {
                  "new": "Package Name from appxmanifest.xml.",
                  "old": "Package Name from appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFamilyName",
                "Description": {
                  "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                  "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFullName",
                "Description": {
                  "new": "Package Full Name from appxmanifest.xml.",
                  "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "displayName",
                "Description": {
                  "new": "User friendly Name to be displayed in the portal.",
                  "old": "User friendly Name to be displayed in the portal. "
                }
              },
              {
                "#name": "packageRelativePath",
                "Description": {
                  "new": "Relative Path to the package inside the image.",
                  "old": "Relative Path to the package inside the image. "
                }
              },
              {
                "#name": "isActive",
                "Description": {
                  "new": "Make this version of the package the active one across the hostpool.",
                  "old": "Make this version of the package the active one across the hostpool. "
                }
              },
              {
                "#name": "packageDependencies",
                "Description": {
                  "new": "List of package dependencies.",
                  "old": "List of package dependencies. "
                },
                "$items": {
                  "$properties": [
                    {
                      "#name": "dependencyName",
                      "Description": {
                        "new": "Name of package dependency.",
                        "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "version",
                "Description": {
                  "new": "Package version found in the appxmanifest.xml.",
                  "old": "Package Version found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "lastUpdated",
                "Description": {
                  "new": "Date Package was last updated, found in the appxmanifest.xml.",
                  "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageApplications",
                "Description": {
                  "new": "List of package applications.",
                  "old": "List of package applications. "
                }
              },
              {
                "#name": "certificateName",
                "Description": {
                  "new": "Certificate name found in the appxmanifest.xml.",
                  "old": "Certificate name found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "certificateExpiry",
                "Description": {
                  "new": "Date certificate expires, found in the appxmanifest.xml.",
                  "old": "Date certificate expires, found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "isPackageTimestamped",
                "Enum": {
                  "new": [
                    [
                      "Timestamped",
                      "Package is timestamped"
                    ],
                    [
                      "NotTimestamped",
                      "Package is not timestamped, use certificate expiry date"
                    ]
                  ],
                  "old": [
                    [
                      "Timestamped",
                      ""
                    ],
                    [
                      "NotTimestamped",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "keyVaultURL",
            "Description": {
              "new": "URL path to certificate name located in keyVault",
              "old": "URL of keyvault location to store certificate"
            }
          },
          {
            "#name": "failHealthCheckOnStagingFailure",
            "Enum": {
              "new": [
                [
                  "Unhealthy",
                  "Health Check will report unhealthy"
                ],
                [
                  "NeedsAssistance",
                  "Health Check will report NeedsAssistance"
                ],
                [
                  "DoNotFail",
                  "Health Check will not report failure"
                ]
              ],
              "old": [
                [
                  "Unhealthy",
                  ""
                ],
                [
                  "NeedsAssistance",
                  ""
                ],
                [
                  "DoNotFail",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
appAttachPackageName: string ,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "AppAttachPackage_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "appAttachPackageName",
      "Description": {
        "new": "The name of the App Attach package",
        "old": "The name of the App Attach package arm object"
      }
    },
    {
      "appAttachPackage": {
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Succeeded",
                    "Provisioning Successful"
                  ],
                  [
                    "Provisioning",
                    "Provisioning in Progress"
                  ],
                  [
                    "Failed",
                    "Provisioning Failed"
                  ],
                  [
                    "Canceled",
                    "Provisioning was Canceled"
                  ]
                ],
                "old": [
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ]
                ]
              }
            },
            {
              "image": [
                {
                  "#name": "imagePath",
                  "Description": {
                    "new": "VHD/CIM image path on Network Share.",
                    "old": "VHD/CIM/APP-V image path on Network Share."
                  }
                },
                {
                  "#name": "packageName",
                  "Description": {
                    "new": "Package Name from appxmanifest.xml.",
                    "old": "Package Name from appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageFamilyName",
                  "Description": {
                    "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                    "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageFullName",
                  "Description": {
                    "new": "Package Full Name from appxmanifest.xml.",
                    "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "displayName",
                  "Description": {
                    "new": "User friendly Name to be displayed in the portal.",
                    "old": "User friendly Name to be displayed in the portal. "
                  }
                },
                {
                  "#name": "packageRelativePath",
                  "Description": {
                    "new": "Relative Path to the package inside the image.",
                    "old": "Relative Path to the package inside the image. "
                  }
                },
                {
                  "#name": "isActive",
                  "Description": {
                    "new": "Make this version of the package the active one across the hostpool.",
                    "old": "Make this version of the package the active one across the hostpool. "
                  }
                },
                {
                  "#name": "packageDependencies",
                  "Description": {
                    "new": "List of package dependencies.",
                    "old": "List of package dependencies. "
                  },
                  "$items": {
                    "$properties": [
                      {
                        "#name": "dependencyName",
                        "Description": {
                          "new": "Name of package dependency.",
                          "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Package version found in the appxmanifest.xml.",
                    "old": "Package Version found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "lastUpdated",
                  "Description": {
                    "new": "Date Package was last updated, found in the appxmanifest.xml.",
                    "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageApplications",
                  "Description": {
                    "new": "List of package applications.",
                    "old": "List of package applications. "
                  }
                },
                {
                  "#name": "certificateName",
                  "Description": {
                    "new": "Certificate name found in the appxmanifest.xml.",
                    "old": "Certificate name found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "certificateExpiry",
                  "Description": {
                    "new": "Date certificate expires, found in the appxmanifest.xml.",
                    "old": "Date certificate expires, found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "isPackageTimestamped",
                  "Enum": {
                    "new": [
                      [
                        "Timestamped",
                        "Package is timestamped"
                      ],
                      [
                        "NotTimestamped",
                        "Package is not timestamped, use certificate expiry date"
                      ]
                    ],
                    "old": [
                      [
                        "Timestamped",
                        ""
                      ],
                      [
                        "NotTimestamped",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#name": "keyVaultURL",
              "Description": {
                "new": "URL path to certificate name located in keyVault",
                "old": "URL of keyvault location to store certificate"
              }
            },
            {
              "#name": "failHealthCheckOnStagingFailure",
              "Enum": {
                "new": [
                  [
                    "Unhealthy",
                    "Health Check will report unhealthy"
                  ],
                  [
                    "NeedsAssistance",
                    "Health Check will report NeedsAssistance"
                  ],
                  [
                    "DoNotFail",
                    "Health Check will not report failure"
                  ]
                ],
                "old": [
                  [
                    "Unhealthy",
                    ""
                  ],
                  [
                    "NeedsAssistance",
                    ""
                  ],
                  [
                    "DoNotFail",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Succeeded",
                  "Provisioning Successful"
                ],
                [
                  "Provisioning",
                  "Provisioning in Progress"
                ],
                [
                  "Failed",
                  "Provisioning Failed"
                ],
                [
                  "Canceled",
                  "Provisioning was Canceled"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ]
              ]
            }
          },
          {
            "image": [
              {
                "#name": "imagePath",
                "Description": {
                  "new": "VHD/CIM image path on Network Share.",
                  "old": "VHD/CIM/APP-V image path on Network Share."
                }
              },
              {
                "#name": "packageName",
                "Description": {
                  "new": "Package Name from appxmanifest.xml.",
                  "old": "Package Name from appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFamilyName",
                "Description": {
                  "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                  "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFullName",
                "Description": {
                  "new": "Package Full Name from appxmanifest.xml.",
                  "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "displayName",
                "Description": {
                  "new": "User friendly Name to be displayed in the portal.",
                  "old": "User friendly Name to be displayed in the portal. "
                }
              },
              {
                "#name": "packageRelativePath",
                "Description": {
                  "new": "Relative Path to the package inside the image.",
                  "old": "Relative Path to the package inside the image. "
                }
              },
              {
                "#name": "isActive",
                "Description": {
                  "new": "Make this version of the package the active one across the hostpool.",
                  "old": "Make this version of the package the active one across the hostpool. "
                }
              },
              {
                "#name": "packageDependencies",
                "Description": {
                  "new": "List of package dependencies.",
                  "old": "List of package dependencies. "
                },
                "$items": {
                  "$properties": [
                    {
                      "#name": "dependencyName",
                      "Description": {
                        "new": "Name of package dependency.",
                        "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "version",
                "Description": {
                  "new": "Package version found in the appxmanifest.xml.",
                  "old": "Package Version found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "lastUpdated",
                "Description": {
                  "new": "Date Package was last updated, found in the appxmanifest.xml.",
                  "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageApplications",
                "Description": {
                  "new": "List of package applications.",
                  "old": "List of package applications. "
                }
              },
              {
                "#name": "certificateName",
                "Description": {
                  "new": "Certificate name found in the appxmanifest.xml.",
                  "old": "Certificate name found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "certificateExpiry",
                "Description": {
                  "new": "Date certificate expires, found in the appxmanifest.xml.",
                  "old": "Date certificate expires, found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "isPackageTimestamped",
                "Enum": {
                  "new": [
                    [
                      "Timestamped",
                      "Package is timestamped"
                    ],
                    [
                      "NotTimestamped",
                      "Package is not timestamped, use certificate expiry date"
                    ]
                  ],
                  "old": [
                    [
                      "Timestamped",
                      ""
                    ],
                    [
                      "NotTimestamped",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "keyVaultURL",
            "Description": {
              "new": "URL path to certificate name located in keyVault",
              "old": "URL of keyvault location to store certificate"
            }
          },
          {
            "#name": "failHealthCheckOnStagingFailure",
            "Enum": {
              "new": [
                [
                  "Unhealthy",
                  "Health Check will report unhealthy"
                ],
                [
                  "NeedsAssistance",
                  "Health Check will report NeedsAssistance"
                ],
                [
                  "DoNotFail",
                  "Health Check will not report failure"
                ]
              ],
              "old": [
                [
                  "Unhealthy",
                  ""
                ],
                [
                  "NeedsAssistance",
                  ""
                ],
                [
                  "DoNotFail",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Succeeded",
                  "Provisioning Successful"
                ],
                [
                  "Provisioning",
                  "Provisioning in Progress"
                ],
                [
                  "Failed",
                  "Provisioning Failed"
                ],
                [
                  "Canceled",
                  "Provisioning was Canceled"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ]
              ]
            }
          },
          {
            "image": [
              {
                "#name": "imagePath",
                "Description": {
                  "new": "VHD/CIM image path on Network Share.",
                  "old": "VHD/CIM/APP-V image path on Network Share."
                }
              },
              {
                "#name": "packageName",
                "Description": {
                  "new": "Package Name from appxmanifest.xml.",
                  "old": "Package Name from appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFamilyName",
                "Description": {
                  "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                  "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFullName",
                "Description": {
                  "new": "Package Full Name from appxmanifest.xml.",
                  "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "displayName",
                "Description": {
                  "new": "User friendly Name to be displayed in the portal.",
                  "old": "User friendly Name to be displayed in the portal. "
                }
              },
              {
                "#name": "packageRelativePath",
                "Description": {
                  "new": "Relative Path to the package inside the image.",
                  "old": "Relative Path to the package inside the image. "
                }
              },
              {
                "#name": "isActive",
                "Description": {
                  "new": "Make this version of the package the active one across the hostpool.",
                  "old": "Make this version of the package the active one across the hostpool. "
                }
              },
              {
                "#name": "packageDependencies",
                "Description": {
                  "new": "List of package dependencies.",
                  "old": "List of package dependencies. "
                },
                "$items": {
                  "$properties": [
                    {
                      "#name": "dependencyName",
                      "Description": {
                        "new": "Name of package dependency.",
                        "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "version",
                "Description": {
                  "new": "Package version found in the appxmanifest.xml.",
                  "old": "Package Version found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "lastUpdated",
                "Description": {
                  "new": "Date Package was last updated, found in the appxmanifest.xml.",
                  "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageApplications",
                "Description": {
                  "new": "List of package applications.",
                  "old": "List of package applications. "
                }
              },
              {
                "#name": "certificateName",
                "Description": {
                  "new": "Certificate name found in the appxmanifest.xml.",
                  "old": "Certificate name found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "certificateExpiry",
                "Description": {
                  "new": "Date certificate expires, found in the appxmanifest.xml.",
                  "old": "Date certificate expires, found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "isPackageTimestamped",
                "Enum": {
                  "new": [
                    [
                      "Timestamped",
                      "Package is timestamped"
                    ],
                    [
                      "NotTimestamped",
                      "Package is not timestamped, use certificate expiry date"
                    ]
                  ],
                  "old": [
                    [
                      "Timestamped",
                      ""
                    ],
                    [
                      "NotTimestamped",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "keyVaultURL",
            "Description": {
              "new": "URL path to certificate name located in keyVault",
              "old": "URL of keyvault location to store certificate"
            }
          },
          {
            "#name": "failHealthCheckOnStagingFailure",
            "Enum": {
              "new": [
                [
                  "Unhealthy",
                  "Health Check will report unhealthy"
                ],
                [
                  "NeedsAssistance",
                  "Health Check will report NeedsAssistance"
                ],
                [
                  "DoNotFail",
                  "Health Check will not report failure"
                ]
              ],
              "old": [
                [
                  "Unhealthy",
                  ""
                ],
                [
                  "NeedsAssistance",
                  ""
                ],
                [
                  "DoNotFail",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
appAttachPackageName: string ,
appAttachPackage:
{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}

⚐ Response (201)

{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "AppAttachPackage_Update",
  "$parameters": [
    {
      "#name": "appAttachPackageName",
      "Description": {
        "new": "The name of the App Attach package",
        "old": "The name of the App Attach package arm object"
      }
    },
    {
      "#name": "appAttachPackagePatch",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing App Attach Package definition."
      },
      "$schema": {
        "Description": {
          "new": "Schema for updatable App Attach Package properties.",
          "old": "Schema for patchable App Attach Package properties."
        },
        "$properties": {
          "properties": [
            {
              "image": [
                {
                  "#name": "imagePath",
                  "Description": {
                    "new": "VHD/CIM image path on Network Share.",
                    "old": "VHD/CIM/APP-V image path on Network Share."
                  }
                },
                {
                  "#name": "packageName",
                  "Description": {
                    "new": "Package Name from appxmanifest.xml.",
                    "old": "Package Name from appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageFamilyName",
                  "Description": {
                    "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                    "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageFullName",
                  "Description": {
                    "new": "Package Full Name from appxmanifest.xml.",
                    "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "displayName",
                  "Description": {
                    "new": "User friendly Name to be displayed in the portal.",
                    "old": "User friendly Name to be displayed in the portal. "
                  }
                },
                {
                  "#name": "packageRelativePath",
                  "Description": {
                    "new": "Relative Path to the package inside the image.",
                    "old": "Relative Path to the package inside the image. "
                  }
                },
                {
                  "#name": "isActive",
                  "Description": {
                    "new": "Make this version of the package the active one across the hostpool.",
                    "old": "Make this version of the package the active one across the hostpool. "
                  }
                },
                {
                  "#name": "packageDependencies",
                  "Description": {
                    "new": "List of package dependencies.",
                    "old": "List of package dependencies. "
                  },
                  "$items": {
                    "$properties": [
                      {
                        "#name": "dependencyName",
                        "Description": {
                          "new": "Name of package dependency.",
                          "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Package version found in the appxmanifest.xml.",
                    "old": "Package Version found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "lastUpdated",
                  "Description": {
                    "new": "Date Package was last updated, found in the appxmanifest.xml.",
                    "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageApplications",
                  "Description": {
                    "new": "List of package applications.",
                    "old": "List of package applications. "
                  }
                },
                {
                  "#name": "certificateName",
                  "Description": {
                    "new": "Certificate name found in the appxmanifest.xml.",
                    "old": "Certificate name found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "certificateExpiry",
                  "Description": {
                    "new": "Date certificate expires, found in the appxmanifest.xml.",
                    "old": "Date certificate expires, found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "isPackageTimestamped",
                  "Enum": {
                    "new": [
                      [
                        "Timestamped",
                        "Package is timestamped"
                      ],
                      [
                        "NotTimestamped",
                        "Package is not timestamped, use certificate expiry date"
                      ]
                    ],
                    "old": [
                      [
                        "Timestamped",
                        ""
                      ],
                      [
                        "NotTimestamped",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#name": "keyVaultURL",
              "Description": {
                "new": "URL path to certificate name located in keyVault",
                "old": "URL of keyvault location to store certificate"
              }
            },
            {
              "#name": "failHealthCheckOnStagingFailure",
              "Enum": {
                "new": [
                  [
                    "Unhealthy",
                    "Health Check will report unhealthy"
                  ],
                  [
                    "NeedsAssistance",
                    "Health Check will report NeedsAssistance"
                  ],
                  [
                    "DoNotFail",
                    "Health Check will not report failure"
                  ]
                ],
                "old": [
                  [
                    "Unhealthy",
                    ""
                  ],
                  [
                    "NeedsAssistance",
                    ""
                  ],
                  [
                    "DoNotFail",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "packageLookbackUrl",
              "Description": {
                "new": "Lookback url to third party control plane, is null for native app attach packages",
                "old": "Lookback url to third party control plane, should be null for first party packages"
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Succeeded",
                  "Provisioning Successful"
                ],
                [
                  "Provisioning",
                  "Provisioning in Progress"
                ],
                [
                  "Failed",
                  "Provisioning Failed"
                ],
                [
                  "Canceled",
                  "Provisioning was Canceled"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ]
              ]
            }
          },
          {
            "image": [
              {
                "#name": "imagePath",
                "Description": {
                  "new": "VHD/CIM image path on Network Share.",
                  "old": "VHD/CIM/APP-V image path on Network Share."
                }
              },
              {
                "#name": "packageName",
                "Description": {
                  "new": "Package Name from appxmanifest.xml.",
                  "old": "Package Name from appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFamilyName",
                "Description": {
                  "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                  "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageFullName",
                "Description": {
                  "new": "Package Full Name from appxmanifest.xml.",
                  "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                }
              },
              {
                "#name": "displayName",
                "Description": {
                  "new": "User friendly Name to be displayed in the portal.",
                  "old": "User friendly Name to be displayed in the portal. "
                }
              },
              {
                "#name": "packageRelativePath",
                "Description": {
                  "new": "Relative Path to the package inside the image.",
                  "old": "Relative Path to the package inside the image. "
                }
              },
              {
                "#name": "isActive",
                "Description": {
                  "new": "Make this version of the package the active one across the hostpool.",
                  "old": "Make this version of the package the active one across the hostpool. "
                }
              },
              {
                "#name": "packageDependencies",
                "Description": {
                  "new": "List of package dependencies.",
                  "old": "List of package dependencies. "
                },
                "$items": {
                  "$properties": [
                    {
                      "#name": "dependencyName",
                      "Description": {
                        "new": "Name of package dependency.",
                        "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                      }
                    }
                  ]
                }
              },
              {
                "#name": "version",
                "Description": {
                  "new": "Package version found in the appxmanifest.xml.",
                  "old": "Package Version found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "lastUpdated",
                "Description": {
                  "new": "Date Package was last updated, found in the appxmanifest.xml.",
                  "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "packageApplications",
                "Description": {
                  "new": "List of package applications.",
                  "old": "List of package applications. "
                }
              },
              {
                "#name": "certificateName",
                "Description": {
                  "new": "Certificate name found in the appxmanifest.xml.",
                  "old": "Certificate name found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "certificateExpiry",
                "Description": {
                  "new": "Date certificate expires, found in the appxmanifest.xml.",
                  "old": "Date certificate expires, found in the appxmanifest.xml. "
                }
              },
              {
                "#name": "isPackageTimestamped",
                "Enum": {
                  "new": [
                    [
                      "Timestamped",
                      "Package is timestamped"
                    ],
                    [
                      "NotTimestamped",
                      "Package is not timestamped, use certificate expiry date"
                    ]
                  ],
                  "old": [
                    [
                      "Timestamped",
                      ""
                    ],
                    [
                      "NotTimestamped",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "keyVaultURL",
            "Description": {
              "new": "URL path to certificate name located in keyVault",
              "old": "URL of keyvault location to store certificate"
            }
          },
          {
            "#name": "failHealthCheckOnStagingFailure",
            "Enum": {
              "new": [
                [
                  "Unhealthy",
                  "Health Check will report unhealthy"
                ],
                [
                  "NeedsAssistance",
                  "Health Check will report NeedsAssistance"
                ],
                [
                  "DoNotFail",
                  "Health Check will not report failure"
                ]
              ],
              "old": [
                [
                  "Unhealthy",
                  ""
                ],
                [
                  "NeedsAssistance",
                  ""
                ],
                [
                  "DoNotFail",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
appAttachPackageName: string ,
appAttachPackagePatch:
{
tags: object ,
properties:
{
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageLookbackUrl: string ,
customData: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "AppAttachPackage_Delete",
  "$parameters": [
    {
      "#name": "appAttachPackageName",
      "Description": {
        "new": "The name of the App Attach package",
        "old": "The name of the App Attach package arm object"
      }
    },
    {
      "#name": "force",
      "Description": {
        "new": "Allows force delete",
        "old": "Force flag to delete App Attach package."
      }
    }
  ]
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/appAttachPackages/{appAttachPackageName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
appAttachPackageName: string ,
force: boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ApplicationGroups_ListByResourceGroup (updated)
Description List applicationGroups.
Reference Link ¶

⚶ Changes

{
  "#id": "ApplicationGroups_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ApplicationGroup items on this page",
            "old": "List of ApplicationGroup definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "applicationGroupType",
                  "Enum": {
                    "new": [
                      [
                        "RemoteApp",
                        "Application group is Remote and can launch individual applications without a Desktop."
                      ],
                      [
                        "Desktop",
                        "Application Group delivers a full expected Desktop experience"
                      ]
                    ],
                    "old": [
                      [
                        "RemoteApp",
                        ""
                      ],
                      [
                        "Desktop",
                        ""
                      ]
                    ]
                  }
                }
              ],
              "@added_9332debb12f04ea2a12e83361650dacd": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_f1bb593336d447568148263be2ec3687": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_355129f2777f4ce9adc3640e345ef3e4": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_e11b5436d11242cebeb43a455e34d7a2": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_126de3a2fd364ea5b73b789d8bccb75e": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_c36ccd235a284590a0c62a50cb455723": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_14475ef1902b4622ba26841033211590": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b36832f9f9304fb1ab982a3843ef755c": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_df616d1893924a5baae06e6f65c28dbe": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
$filter: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ApplicationGroups_Get (updated)
Description Get an application group.
Reference Link ¶

⚶ Changes

{
  "#id": "ApplicationGroups_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationGroupType",
            "Enum": {
              "new": [
                [
                  "RemoteApp",
                  "Application group is Remote and can launch individual applications without a Desktop."
                ],
                [
                  "Desktop",
                  "Application Group delivers a full expected Desktop experience"
                ]
              ],
              "old": [
                [
                  "RemoteApp",
                  ""
                ],
                [
                  "Desktop",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_742eb02dcfc84be4b94029c8251cceaa": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_34c71a84237041228adeba90fc5ff507": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_fdd574b5c3fb4ed38fb27b4d9fa3a319": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_1491368bb3a64469886eb898286b53e0": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_b01b04aa7705493e844ec369fff758cc": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_a02407e53a25428cb994de2218af36ac": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_ec14d6dd2aa84ac389246f6a36795dc5": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_8691fa6ddfb3443eb47b16c2c583bf37": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_54216cc107444d4994071e0ea219c3f2": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ApplicationGroups_CreateOrUpdate (updated)
Description Create or update an applicationGroup.
Reference Link ¶

⚶ Changes

{
  "#id": "ApplicationGroups_CreateOrUpdate",
  "$parameters": {
    "applicationGroup": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationGroupType",
            "Enum": {
              "new": [
                [
                  "RemoteApp",
                  "Application group is Remote and can launch individual applications without a Desktop."
                ],
                [
                  "Desktop",
                  "Application Group delivers a full expected Desktop experience"
                ]
              ],
              "old": [
                [
                  "RemoteApp",
                  ""
                ],
                [
                  "Desktop",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_f26ee81ab0dc44e28e8953fea58d4d1b": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_a4177cbd0a514cd3b0efe03e3d16b6f2": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_09b189e3b52847d4bda6964f7f14f0d8": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_caa03a3bef604c3fb59b7230f06b5c56": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_173e8c0251d24655993bb1eeba6e0df8": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_28dc08a62f904f21afd66f87d1261ca1": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationGroupType",
            "Enum": {
              "new": [
                [
                  "RemoteApp",
                  "Application group is Remote and can launch individual applications without a Desktop."
                ],
                [
                  "Desktop",
                  "Application Group delivers a full expected Desktop experience"
                ]
              ],
              "old": [
                [
                  "RemoteApp",
                  ""
                ],
                [
                  "Desktop",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_7d568f9393b240a391ca060d4fdec8c8": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_0226f02777404a00ab3476ff34d640c7": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_a0ad9849dded40a8afeb9db0aec8fcd8": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_67eeb64fa2384b11931c321d54fa0970": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_68059a6f761d4970a434aaa0adf450bb": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_de0d03e7d59241d8a0095da84bba63bb": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationGroupType",
            "Enum": {
              "new": [
                [
                  "RemoteApp",
                  "Application group is Remote and can launch individual applications without a Desktop."
                ],
                [
                  "Desktop",
                  "Application Group delivers a full expected Desktop experience"
                ]
              ],
              "old": [
                [
                  "RemoteApp",
                  ""
                ],
                [
                  "Desktop",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_54844d925e8c4041a744a885deb61a6b": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_18ed25cf637d4aeda831f37916f32675": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_a3f20bde30f0450ab812124eb58b381a": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_37b35df7f9b8459e8ef95617a7f43b0d": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_567c96fd50bb48b68bfccb061b1351bc": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_05f74b7141344752b18df0a4dd8dfa3f": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_a5c0588e6d4441d3b1d11d95f4558449": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_39ac5da9d01a4678a321c2b27868fa52": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_a9acb5ff137a468d9cc9bead9476235b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
applicationGroup:
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ApplicationGroups_Update (updated)
Description Update an applicationGroup.
Reference Link ¶

⚶ Changes

{
  "#id": "ApplicationGroups_Update",
  "$parameters": [
    {
      "#name": "applicationGroup",
      "Description": {
        "new": "The AppGroup properties to be updated",
        "old": "Object containing ApplicationGroup definitions."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationGroupType",
            "Enum": {
              "new": [
                [
                  "RemoteApp",
                  "Application group is Remote and can launch individual applications without a Desktop."
                ],
                [
                  "Desktop",
                  "Application Group delivers a full expected Desktop experience"
                ]
              ],
              "old": [
                [
                  "RemoteApp",
                  ""
                ],
                [
                  "Desktop",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_fc5f078468e9427499ef2a2cb92a7286": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_e8f7718fdaec4c34b2f234d546e8f35c": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_fb045a1135104af5955125f67d25072c": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_b91af3d9af52443e8b8b84e62a7c773a": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_b0ffadc0a01a4c60aa5bba1f49f8a64b": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_ac463064f1f74c139cb4390e86a1bd24": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_d18d749c93a34d7e9a8b49f4ddcd40b4": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_603892dccdd140ed9f5d124de13a456b": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_938ce409d0eb4da488282c471cdc114b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
applicationGroup:
{
tags: object ,
properties:
{
description: string ,
friendlyName: string ,
showInFeed: boolean ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
hostPoolArmPath: string ,
workspaceArmPath: string ,
applicationGroupType: enum ,
cloudPcResource: boolean ,
showInFeed: boolean ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ApplicationGroups_Delete (updated)
Description Remove an applicationGroup.
Reference Link ¶

⚶ Changes

{
  "#id": "ApplicationGroups_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_efc4496ffc55415695718fddf0b504bf": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_226c3a65b4554fd1b15b8566b7097434": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f340c1fcbf9c4ccd9ba431a0973398a7": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Applications_List (updated)
Description List applications.
Reference Link ¶

⚶ Changes

{
  "#id": "Applications_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Application items on this page",
            "old": "List of Application definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "applicationType",
                  "Enum": {
                    "new": [
                      [
                        "InBuilt",
                        "Built-in applications"
                      ],
                      [
                        "MsixApplication",
                        "Imported MSIX application packages"
                      ]
                    ],
                    "old": [
                      [
                        "InBuilt",
                        ""
                      ],
                      [
                        "MsixApplication",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "commandLineSetting",
                  "Enum": {
                    "new": [
                      [
                        "DoNotAllow",
                        "Cannot be launched with command line arguments."
                      ],
                      [
                        "Allow",
                        "Can optionally be launched with command line arguments."
                      ],
                      [
                        "Require",
                        "Required to be launched with command line arguments."
                      ]
                    ],
                    "old": [
                      [
                        "DoNotAllow",
                        ""
                      ],
                      [
                        "Allow",
                        ""
                      ],
                      [
                        "Require",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f69180acb49d4d93bd35c1dd5ae7726b": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_6a948a2a2f2d4a2b94b49533205c063f": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_ad2c7ed98cce4549a85b17c5aab4c0a6": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
filePath: string ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
iconHash: string ,
iconContent: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Applications_Get (updated)
Description Get an application.
Reference Link ¶

⚶ Changes

{
  "#id": "Applications_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationType",
            "Enum": {
              "new": [
                [
                  "InBuilt",
                  "Built-in applications"
                ],
                [
                  "MsixApplication",
                  "Imported MSIX application packages"
                ]
              ],
              "old": [
                [
                  "InBuilt",
                  ""
                ],
                [
                  "MsixApplication",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "commandLineSetting",
            "Enum": {
              "new": [
                [
                  "DoNotAllow",
                  "Cannot be launched with command line arguments."
                ],
                [
                  "Allow",
                  "Can optionally be launched with command line arguments."
                ],
                [
                  "Require",
                  "Required to be launched with command line arguments."
                ]
              ],
              "old": [
                [
                  "DoNotAllow",
                  ""
                ],
                [
                  "Allow",
                  ""
                ],
                [
                  "Require",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_d79dbae8b4604240adfaeb0e4a19e0ca": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_978582c86e4f416a850bbdf73c2ca9a9": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_91cecd156e764a8299126318abeaad4c": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
applicationName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
filePath: string ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
iconHash: string ,
iconContent: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Applications_CreateOrUpdate (updated)
Description Create or update an application.
Reference Link ¶

⚶ Changes

{
  "#id": "Applications_CreateOrUpdate",
  "$parameters": {
    "application": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationType",
            "Enum": {
              "new": [
                [
                  "InBuilt",
                  "Built-in applications"
                ],
                [
                  "MsixApplication",
                  "Imported MSIX application packages"
                ]
              ],
              "old": [
                [
                  "InBuilt",
                  ""
                ],
                [
                  "MsixApplication",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "commandLineSetting",
            "Enum": {
              "new": [
                [
                  "DoNotAllow",
                  "Cannot be launched with command line arguments."
                ],
                [
                  "Allow",
                  "Can optionally be launched with command line arguments."
                ],
                [
                  "Require",
                  "Required to be launched with command line arguments."
                ]
              ],
              "old": [
                [
                  "DoNotAllow",
                  ""
                ],
                [
                  "Allow",
                  ""
                ],
                [
                  "Require",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationType",
            "Enum": {
              "new": [
                [
                  "InBuilt",
                  "Built-in applications"
                ],
                [
                  "MsixApplication",
                  "Imported MSIX application packages"
                ]
              ],
              "old": [
                [
                  "InBuilt",
                  ""
                ],
                [
                  "MsixApplication",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "commandLineSetting",
            "Enum": {
              "new": [
                [
                  "DoNotAllow",
                  "Cannot be launched with command line arguments."
                ],
                [
                  "Allow",
                  "Can optionally be launched with command line arguments."
                ],
                [
                  "Require",
                  "Required to be launched with command line arguments."
                ]
              ],
              "old": [
                [
                  "DoNotAllow",
                  ""
                ],
                [
                  "Allow",
                  ""
                ],
                [
                  "Require",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationType",
            "Enum": {
              "new": [
                [
                  "InBuilt",
                  "Built-in applications"
                ],
                [
                  "MsixApplication",
                  "Imported MSIX application packages"
                ]
              ],
              "old": [
                [
                  "InBuilt",
                  ""
                ],
                [
                  "MsixApplication",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "commandLineSetting",
            "Enum": {
              "new": [
                [
                  "DoNotAllow",
                  "Cannot be launched with command line arguments."
                ],
                [
                  "Allow",
                  "Can optionally be launched with command line arguments."
                ],
                [
                  "Require",
                  "Required to be launched with command line arguments."
                ]
              ],
              "old": [
                [
                  "DoNotAllow",
                  ""
                ],
                [
                  "Allow",
                  ""
                ],
                [
                  "Require",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_703f3dd339a5458ebe6d14db822ea15c": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_419f5e21526145bdaa67f22a49da6846": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_0a9067ce2e8a43feb0401e29a49a6d7b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
applicationName: string ,
application:
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
filePath: string ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
iconHash: string ,
iconContent: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
filePath: string ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
iconHash: string ,
iconContent: string ,
}
,
}

⚐ Response (201)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
filePath: string ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
iconHash: string ,
iconContent: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Applications_Update (updated)
Description Update an application.
Reference Link ¶

⚶ Changes

{
  "#id": "Applications_Update",
  "$parameters": [
    {
      "#name": "application",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing Application definitions."
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "commandLineSetting",
              "Enum": {
                "new": [
                  [
                    "DoNotAllow",
                    "Cannot be launched with command line arguments."
                  ],
                  [
                    "Allow",
                    "Can optionally be launched with command line arguments."
                  ],
                  [
                    "Require",
                    "Required to be launched with command line arguments."
                  ]
                ],
                "old": [
                  [
                    "DoNotAllow",
                    ""
                  ],
                  [
                    "Allow",
                    ""
                  ],
                  [
                    "Require",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "applicationType",
              "Enum": {
                "new": [
                  [
                    "InBuilt",
                    "Built-in applications"
                  ],
                  [
                    "MsixApplication",
                    "Imported MSIX application packages"
                  ]
                ],
                "old": [
                  [
                    "InBuilt",
                    ""
                  ],
                  [
                    "MsixApplication",
                    ""
                  ]
                ]
              }
            }
          ],
          "@removed_2b185ea11d094dc9b58dcc585ecce4ef": {
            "#name": "tags",
            "Description": "tags to be updated",
            "Required": false,
            "Type": "object"
          }
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationType",
            "Enum": {
              "new": [
                [
                  "InBuilt",
                  "Built-in applications"
                ],
                [
                  "MsixApplication",
                  "Imported MSIX application packages"
                ]
              ],
              "old": [
                [
                  "InBuilt",
                  ""
                ],
                [
                  "MsixApplication",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "commandLineSetting",
            "Enum": {
              "new": [
                [
                  "DoNotAllow",
                  "Cannot be launched with command line arguments."
                ],
                [
                  "Allow",
                  "Can optionally be launched with command line arguments."
                ],
                [
                  "Require",
                  "Required to be launched with command line arguments."
                ]
              ],
              "old": [
                [
                  "DoNotAllow",
                  ""
                ],
                [
                  "Allow",
                  ""
                ],
                [
                  "Require",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_2b3a20dc2aca437caf2269325713ee23": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_e79d1d52850e4705bfffc0870b76b785": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_5ba24c4738f24f3187bb779c3bc1d034": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
applicationName: string ,
application:
{
properties:
{
description: string ,
friendlyName: string ,
filePath: string ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
filePath: string ,
msixPackageFamilyName: string ,
msixPackageApplicationId: string ,
applicationType: enum ,
commandLineSetting: enum ,
commandLineArguments: string ,
showInPortal: boolean ,
iconPath: string ,
iconIndex: integer ,
iconHash: string ,
iconContent: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Applications_Delete (updated)
Description Remove an application.
Reference Link ¶

⚶ Changes

{
  "#id": "Applications_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_97305ddd40f8409f825fbe0052367ef0": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_2007bdb1216a4de691cdef4a1621747b": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_2ec3e04bc51a4340914ce3cf2307f84d": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
applicationName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Desktops_List (updated)
Description List desktops.
Reference Link ¶

⚶ Changes

{
  "#id": "Desktops_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Desktop items on this page",
            "old": "List of Desktop definitions."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_300e0370c86c45baa35809fa5c72e21f": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_84d398581de440d9b149f787662c74f6": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_57b940043e29409fbc076d7cfdedbef4": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
iconHash: string ,
iconContent: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Desktops_Get (updated)
Description Get a desktop.
Reference Link ¶

⚶ Changes

{
  "#id": "Desktops_Get",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_86ac90c4e371418a8d99614528e04123": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_5f79487d255f4ec39c36da60fa7f1a1a": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_742d014f5aed43889718385d5a40837b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
desktopName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
iconHash: string ,
iconContent: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Desktops_Update (updated)
Description Update a desktop.
Reference Link ¶

⚶ Changes

{
  "#id": "Desktops_Update",
  "$parameters": [
    {
      "#name": "desktop",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing Desktop definitions."
      },
      "$schema": {
        "$properties": {
          "@removed_885d8c44807d40eab9ebcc6a434b8555": {
            "#name": "tags",
            "Description": "tags to be updated",
            "Required": false,
            "Type": "object"
          }
        }
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_c32375b6db034c64879d1bb0ea440e2e": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_ff336d81f4d640d0ba35575c7616e2d5": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_63a1f958606840089ecb71ca40686bbe": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
desktopName: string ,
desktop:
{
properties:
{
description: string ,
friendlyName: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
iconHash: string ,
iconContent: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
StartMenuItems_List (updated)
Description List start menu items in the given application group.
Reference Link ¶

⚶ Changes

{
  "#id": "StartMenuItems_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The StartMenuItem items on this page",
            "old": "List of StartMenuItem definitions."
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_20fb7193d51145f3921c31290acd70b4": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_c80f0fe4b30942e787a151342f8f4a91": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_1cef87a8e0ad4db2b7979212e43c4a16": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
applicationGroupName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
appAlias: string ,
filePath: string ,
commandLineArguments: string ,
iconPath: string ,
iconIndex: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_ListByResourceGroup (updated)
Description List hostPools.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The HostPool items on this page",
            "old": "List of HostPool definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "personalDesktopAssignmentType",
                  "Enum": {
                    "new": [
                      [
                        "Automatic",
                        "Automatically assigns an available personal desktop to the user."
                      ],
                      [
                        "Direct",
                        "Manually assigns a specific personal desktop to the user."
                      ]
                    ],
                    "old": [
                      [
                        "Automatic",
                        ""
                      ],
                      [
                        "Direct",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "loadBalancerType",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Uses BreadthFirst algorithm for load balancing."
                      ],
                      [
                        "DepthFirst",
                        "Uses DepthFirst algorithm for load balancing."
                      ],
                      [
                        "Persistent",
                        "Maintains persistent connections."
                      ],
                      [
                        "MultiplePersistent",
                        "Maintains multiple persistents connections."
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ],
                      [
                        "Persistent",
                        ""
                      ],
                      [
                        "MultiplePersistent",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "registrationInfo",
                  "Description": {
                    "new": "The registration info of HostPool.",
                    "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
                  },
                  "$properties": [
                    {
                      "#name": "registrationTokenOperation",
                      "Enum": {
                        "new": [
                          [
                            "Delete",
                            "Delete operation"
                          ],
                          [
                            "None",
                            "No Operation"
                          ],
                          [
                            "Update",
                            "Update Operation"
                          ]
                        ],
                        "old": [
                          [
                            "Delete",
                            ""
                          ],
                          [
                            "None",
                            ""
                          ],
                          [
                            "Update",
                            ""
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "ssoSecretType",
                  "Enum": {
                    "new": [
                      [
                        "SharedKey",
                        "The SSO Secret is a Shared Key."
                      ],
                      [
                        "Certificate",
                        "The SSO Secret is a Certificate."
                      ],
                      [
                        "SharedKeyInKeyVault",
                        "The SSO Secret is a SharedKey that is stored in KeyVault."
                      ],
                      [
                        "CertificateInKeyVault",
                        "The SSO Secret is a Certificate that is stored in KeyVault."
                      ]
                    ],
                    "old": [
                      [
                        "SharedKey",
                        ""
                      ],
                      [
                        "Certificate",
                        ""
                      ],
                      [
                        "SharedKeyInKeyVault",
                        ""
                      ],
                      [
                        "CertificateInKeyVault",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "preferredAppGroupType",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "Internal Use Only"
                      ],
                      [
                        "Desktop",
                        "Use Desktop Application Group"
                      ],
                      [
                        "RailApplications",
                        "Use RailApplications (RemoteApp)"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        "This value is read only, it is not accepted on input."
                      ],
                      [
                        "Desktop",
                        "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                      ],
                      [
                        "RailApplications",
                        "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                      ]
                    ]
                  }
                },
                {
                  "#name": "publicNetworkAccess",
                  "Enum": {
                    "new": [
                      [
                        "Enabled",
                        "Allows this resource to be accessed from the public network"
                      ],
                      [
                        "Disabled",
                        "Prevents this resource from being accessed from the public network"
                      ],
                      [
                        "EnabledForSessionHostsOnly",
                        "Allows SessionHosts to be accessed from the public network"
                      ],
                      [
                        "EnabledForClientsOnly",
                        "Allows Clients to be accessed from the public network"
                      ]
                    ],
                    "old": [
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ],
                      [
                        "EnabledForSessionHostsOnly",
                        ""
                      ],
                      [
                        "EnabledForClientsOnly",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "privateEndpointConnections": {
                    "$properties": {
                      "properties": [
                        {
                          "privateLinkServiceConnectionState": [
                            {
                              "#name": "status",
                              "Enum": {
                                "new": [
                                  [
                                    "Pending",
                                    "Connection is Pending"
                                  ],
                                  [
                                    "Approved",
                                    "Connection was Approved"
                                  ],
                                  [
                                    "Rejected",
                                    "Connection was rejected"
                                  ]
                                ],
                                "old": [
                                  [
                                    "Pending",
                                    ""
                                  ],
                                  [
                                    "Approved",
                                    ""
                                  ],
                                  [
                                    "Rejected",
                                    ""
                                  ]
                                ]
                              }
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Succeeded",
                                "Provisioning was successful"
                              ],
                              [
                                "Creating",
                                "A PrivateEndpointConnection is being created"
                              ],
                              [
                                "Deleting",
                                "A PrivateEndpointConnection is being deleted"
                              ],
                              [
                                "Failed",
                                "Provisioning failed"
                              ]
                            ],
                            "old": [
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                },
                {
                  "#name": "managedPrivateUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "directUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "publicUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "relayUDP",
                  "Enum": {
                    "new": [
                      [
                        "Default",
                        "AVD-wide settings are used to determine connection availability"
                      ],
                      [
                        "Enabled",
                        "UDP will attempt this connection type when making connections."
                      ],
                      [
                        "Disabled",
                        "UDP will not attempt this connection type when making connections"
                      ]
                    ],
                    "old": [
                      [
                        "Default",
                        ""
                      ],
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "managementType",
                  "Enum": {
                    "new": [
                      [
                        "Automated",
                        "Automated management of the hostpool"
                      ],
                      [
                        "Standard",
                        "Standard management of the hostpool"
                      ]
                    ],
                    "old": [
                      [
                        "Automated",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ]
                    ]
                  }
                }
              ],
              "@added_9368c697496348f7a504370ae96971f5": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_f04f5a654ac04e95836a378bd0b11581": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_8f3fa45b86ef42138bfac13fa4b5defd": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_d208c2cff2524397a240e2f03ed591b8": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_f9eedda479924c1aa7624fe97004aaaf": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_a34c6e17459a4ac0aa3334f1fee9740b": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_35399c173f684986a409ad5f7ec2a1ff": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_1999e699ae3f49168ed7cf30ba1fb4c2": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_3a4d32537cc34d5f88ae293a75c72ecc": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_Get (updated)
Description Get a host pool.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "personalDesktopAssignmentType",
            "Enum": {
              "new": [
                [
                  "Automatic",
                  "Automatically assigns an available personal desktop to the user."
                ],
                [
                  "Direct",
                  "Manually assigns a specific personal desktop to the user."
                ]
              ],
              "old": [
                [
                  "Automatic",
                  ""
                ],
                [
                  "Direct",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "loadBalancerType",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Uses BreadthFirst algorithm for load balancing."
                ],
                [
                  "DepthFirst",
                  "Uses DepthFirst algorithm for load balancing."
                ],
                [
                  "Persistent",
                  "Maintains persistent connections."
                ],
                [
                  "MultiplePersistent",
                  "Maintains multiple persistents connections."
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ],
                [
                  "Persistent",
                  ""
                ],
                [
                  "MultiplePersistent",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "registrationInfo",
            "Description": {
              "new": "The registration info of HostPool.",
              "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
            },
            "$properties": [
              {
                "#name": "registrationTokenOperation",
                "Enum": {
                  "new": [
                    [
                      "Delete",
                      "Delete operation"
                    ],
                    [
                      "None",
                      "No Operation"
                    ],
                    [
                      "Update",
                      "Update Operation"
                    ]
                  ],
                  "old": [
                    [
                      "Delete",
                      ""
                    ],
                    [
                      "None",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "ssoSecretType",
            "Enum": {
              "new": [
                [
                  "SharedKey",
                  "The SSO Secret is a Shared Key."
                ],
                [
                  "Certificate",
                  "The SSO Secret is a Certificate."
                ],
                [
                  "SharedKeyInKeyVault",
                  "The SSO Secret is a SharedKey that is stored in KeyVault."
                ],
                [
                  "CertificateInKeyVault",
                  "The SSO Secret is a Certificate that is stored in KeyVault."
                ]
              ],
              "old": [
                [
                  "SharedKey",
                  ""
                ],
                [
                  "Certificate",
                  ""
                ],
                [
                  "SharedKeyInKeyVault",
                  ""
                ],
                [
                  "CertificateInKeyVault",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "preferredAppGroupType",
            "Enum": {
              "new": [
                [
                  "None",
                  "Internal Use Only"
                ],
                [
                  "Desktop",
                  "Use Desktop Application Group"
                ],
                [
                  "RailApplications",
                  "Use RailApplications (RemoteApp)"
                ]
              ],
              "old": [
                [
                  "None",
                  "This value is read only, it is not accepted on input."
                ],
                [
                  "Desktop",
                  "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                ],
                [
                  "RailApplications",
                  "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                ]
              ]
            }
          },
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Allows this resource to be accessed from the public network"
                ],
                [
                  "Disabled",
                  "Prevents this resource from being accessed from the public network"
                ],
                [
                  "EnabledForSessionHostsOnly",
                  "Allows SessionHosts to be accessed from the public network"
                ],
                [
                  "EnabledForClientsOnly",
                  "Allows Clients to be accessed from the public network"
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "EnabledForSessionHostsOnly",
                  ""
                ],
                [
                  "EnabledForClientsOnly",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "managedPrivateUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "directUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "publicUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "relayUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "managementType",
            "Enum": {
              "new": [
                [
                  "Automated",
                  "Automated management of the hostpool"
                ],
                [
                  "Standard",
                  "Standard management of the hostpool"
                ]
              ],
              "old": [
                [
                  "Automated",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_326246298cf146e5a0e27a40d428301f": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_95d1a6c5860241c0a079dbfba82f66c7": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_aec7d57d6f4542ef92e37bfc00ff576c": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_089081b419474ff08972171cf905647e": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_dd6bbf51cf3a4131bc48d97be2945d7d": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_228ec93df1114565a388e819289f82f3": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_4c1308f73045432489fc87ef5b5ca4c2": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_229e2f94dcb6475ead0156234416a19e": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_1aa879857569418aa5ffe107f4ccab81": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_CreateOrUpdate (updated)
Description Create or update a host pool.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_CreateOrUpdate",
  "$parameters": {
    "hostPool": {
      "$properties": {
        "properties": [
          {
            "#name": "personalDesktopAssignmentType",
            "Enum": {
              "new": [
                [
                  "Automatic",
                  "Automatically assigns an available personal desktop to the user."
                ],
                [
                  "Direct",
                  "Manually assigns a specific personal desktop to the user."
                ]
              ],
              "old": [
                [
                  "Automatic",
                  ""
                ],
                [
                  "Direct",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "loadBalancerType",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Uses BreadthFirst algorithm for load balancing."
                ],
                [
                  "DepthFirst",
                  "Uses DepthFirst algorithm for load balancing."
                ],
                [
                  "Persistent",
                  "Maintains persistent connections."
                ],
                [
                  "MultiplePersistent",
                  "Maintains multiple persistents connections."
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ],
                [
                  "Persistent",
                  ""
                ],
                [
                  "MultiplePersistent",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "registrationInfo",
            "Description": {
              "new": "The registration info of HostPool.",
              "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
            },
            "$properties": [
              {
                "#name": "registrationTokenOperation",
                "Enum": {
                  "new": [
                    [
                      "Delete",
                      "Delete operation"
                    ],
                    [
                      "None",
                      "No Operation"
                    ],
                    [
                      "Update",
                      "Update Operation"
                    ]
                  ],
                  "old": [
                    [
                      "Delete",
                      ""
                    ],
                    [
                      "None",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "ssoSecretType",
            "Enum": {
              "new": [
                [
                  "SharedKey",
                  "The SSO Secret is a Shared Key."
                ],
                [
                  "Certificate",
                  "The SSO Secret is a Certificate."
                ],
                [
                  "SharedKeyInKeyVault",
                  "The SSO Secret is a SharedKey that is stored in KeyVault."
                ],
                [
                  "CertificateInKeyVault",
                  "The SSO Secret is a Certificate that is stored in KeyVault."
                ]
              ],
              "old": [
                [
                  "SharedKey",
                  ""
                ],
                [
                  "Certificate",
                  ""
                ],
                [
                  "SharedKeyInKeyVault",
                  ""
                ],
                [
                  "CertificateInKeyVault",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "preferredAppGroupType",
            "Enum": {
              "new": [
                [
                  "None",
                  "Internal Use Only"
                ],
                [
                  "Desktop",
                  "Use Desktop Application Group"
                ],
                [
                  "RailApplications",
                  "Use RailApplications (RemoteApp)"
                ]
              ],
              "old": [
                [
                  "None",
                  "This value is read only, it is not accepted on input."
                ],
                [
                  "Desktop",
                  "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                ],
                [
                  "RailApplications",
                  "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                ]
              ]
            }
          },
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Allows this resource to be accessed from the public network"
                ],
                [
                  "Disabled",
                  "Prevents this resource from being accessed from the public network"
                ],
                [
                  "EnabledForSessionHostsOnly",
                  "Allows SessionHosts to be accessed from the public network"
                ],
                [
                  "EnabledForClientsOnly",
                  "Allows Clients to be accessed from the public network"
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "EnabledForSessionHostsOnly",
                  ""
                ],
                [
                  "EnabledForClientsOnly",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "managedPrivateUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "directUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "publicUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "relayUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "managementType",
            "Enum": {
              "new": [
                [
                  "Automated",
                  "Automated management of the hostpool"
                ],
                [
                  "Standard",
                  "Standard management of the hostpool"
                ]
              ],
              "old": [
                [
                  "Automated",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_e41ce112f0b84cdc9663b7e34e3feffe": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_442c911269a540fba0c0cd799d0458ae": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_36343b20e2404e99b854803e3d88ae81": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_e057bab6941348c0885aac11cf322f86": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_0eb0f72cd9ae453c9dde1942803e19ba": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_243c4e9915a34b9ca650b2f2e052da31": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "personalDesktopAssignmentType",
            "Enum": {
              "new": [
                [
                  "Automatic",
                  "Automatically assigns an available personal desktop to the user."
                ],
                [
                  "Direct",
                  "Manually assigns a specific personal desktop to the user."
                ]
              ],
              "old": [
                [
                  "Automatic",
                  ""
                ],
                [
                  "Direct",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "loadBalancerType",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Uses BreadthFirst algorithm for load balancing."
                ],
                [
                  "DepthFirst",
                  "Uses DepthFirst algorithm for load balancing."
                ],
                [
                  "Persistent",
                  "Maintains persistent connections."
                ],
                [
                  "MultiplePersistent",
                  "Maintains multiple persistents connections."
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ],
                [
                  "Persistent",
                  ""
                ],
                [
                  "MultiplePersistent",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "registrationInfo",
            "Description": {
              "new": "The registration info of HostPool.",
              "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
            },
            "$properties": [
              {
                "#name": "registrationTokenOperation",
                "Enum": {
                  "new": [
                    [
                      "Delete",
                      "Delete operation"
                    ],
                    [
                      "None",
                      "No Operation"
                    ],
                    [
                      "Update",
                      "Update Operation"
                    ]
                  ],
                  "old": [
                    [
                      "Delete",
                      ""
                    ],
                    [
                      "None",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "ssoSecretType",
            "Enum": {
              "new": [
                [
                  "SharedKey",
                  "The SSO Secret is a Shared Key."
                ],
                [
                  "Certificate",
                  "The SSO Secret is a Certificate."
                ],
                [
                  "SharedKeyInKeyVault",
                  "The SSO Secret is a SharedKey that is stored in KeyVault."
                ],
                [
                  "CertificateInKeyVault",
                  "The SSO Secret is a Certificate that is stored in KeyVault."
                ]
              ],
              "old": [
                [
                  "SharedKey",
                  ""
                ],
                [
                  "Certificate",
                  ""
                ],
                [
                  "SharedKeyInKeyVault",
                  ""
                ],
                [
                  "CertificateInKeyVault",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "preferredAppGroupType",
            "Enum": {
              "new": [
                [
                  "None",
                  "Internal Use Only"
                ],
                [
                  "Desktop",
                  "Use Desktop Application Group"
                ],
                [
                  "RailApplications",
                  "Use RailApplications (RemoteApp)"
                ]
              ],
              "old": [
                [
                  "None",
                  "This value is read only, it is not accepted on input."
                ],
                [
                  "Desktop",
                  "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                ],
                [
                  "RailApplications",
                  "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                ]
              ]
            }
          },
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Allows this resource to be accessed from the public network"
                ],
                [
                  "Disabled",
                  "Prevents this resource from being accessed from the public network"
                ],
                [
                  "EnabledForSessionHostsOnly",
                  "Allows SessionHosts to be accessed from the public network"
                ],
                [
                  "EnabledForClientsOnly",
                  "Allows Clients to be accessed from the public network"
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "EnabledForSessionHostsOnly",
                  ""
                ],
                [
                  "EnabledForClientsOnly",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "managedPrivateUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "directUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "publicUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "relayUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "managementType",
            "Enum": {
              "new": [
                [
                  "Automated",
                  "Automated management of the hostpool"
                ],
                [
                  "Standard",
                  "Standard management of the hostpool"
                ]
              ],
              "old": [
                [
                  "Automated",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_55d9d86ba8cb4303abd1fe81a54da7ad": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_462507e58a1e4b2f99dfc9826094c726": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_ec98229032674380a6165a8374a5f8d0": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_a16f2a5c435044d59e7c55b689206615": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_436bb539083647a6ba5d66dc1459c4f8": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_f2a0e0a2872d44fa94f7d98aab6e9a9e": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "personalDesktopAssignmentType",
            "Enum": {
              "new": [
                [
                  "Automatic",
                  "Automatically assigns an available personal desktop to the user."
                ],
                [
                  "Direct",
                  "Manually assigns a specific personal desktop to the user."
                ]
              ],
              "old": [
                [
                  "Automatic",
                  ""
                ],
                [
                  "Direct",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "loadBalancerType",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Uses BreadthFirst algorithm for load balancing."
                ],
                [
                  "DepthFirst",
                  "Uses DepthFirst algorithm for load balancing."
                ],
                [
                  "Persistent",
                  "Maintains persistent connections."
                ],
                [
                  "MultiplePersistent",
                  "Maintains multiple persistents connections."
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ],
                [
                  "Persistent",
                  ""
                ],
                [
                  "MultiplePersistent",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "registrationInfo",
            "Description": {
              "new": "The registration info of HostPool.",
              "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
            },
            "$properties": [
              {
                "#name": "registrationTokenOperation",
                "Enum": {
                  "new": [
                    [
                      "Delete",
                      "Delete operation"
                    ],
                    [
                      "None",
                      "No Operation"
                    ],
                    [
                      "Update",
                      "Update Operation"
                    ]
                  ],
                  "old": [
                    [
                      "Delete",
                      ""
                    ],
                    [
                      "None",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "ssoSecretType",
            "Enum": {
              "new": [
                [
                  "SharedKey",
                  "The SSO Secret is a Shared Key."
                ],
                [
                  "Certificate",
                  "The SSO Secret is a Certificate."
                ],
                [
                  "SharedKeyInKeyVault",
                  "The SSO Secret is a SharedKey that is stored in KeyVault."
                ],
                [
                  "CertificateInKeyVault",
                  "The SSO Secret is a Certificate that is stored in KeyVault."
                ]
              ],
              "old": [
                [
                  "SharedKey",
                  ""
                ],
                [
                  "Certificate",
                  ""
                ],
                [
                  "SharedKeyInKeyVault",
                  ""
                ],
                [
                  "CertificateInKeyVault",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "preferredAppGroupType",
            "Enum": {
              "new": [
                [
                  "None",
                  "Internal Use Only"
                ],
                [
                  "Desktop",
                  "Use Desktop Application Group"
                ],
                [
                  "RailApplications",
                  "Use RailApplications (RemoteApp)"
                ]
              ],
              "old": [
                [
                  "None",
                  "This value is read only, it is not accepted on input."
                ],
                [
                  "Desktop",
                  "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                ],
                [
                  "RailApplications",
                  "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                ]
              ]
            }
          },
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Allows this resource to be accessed from the public network"
                ],
                [
                  "Disabled",
                  "Prevents this resource from being accessed from the public network"
                ],
                [
                  "EnabledForSessionHostsOnly",
                  "Allows SessionHosts to be accessed from the public network"
                ],
                [
                  "EnabledForClientsOnly",
                  "Allows Clients to be accessed from the public network"
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "EnabledForSessionHostsOnly",
                  ""
                ],
                [
                  "EnabledForClientsOnly",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "managedPrivateUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "directUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "publicUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "relayUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "managementType",
            "Enum": {
              "new": [
                [
                  "Automated",
                  "Automated management of the hostpool"
                ],
                [
                  "Standard",
                  "Standard management of the hostpool"
                ]
              ],
              "old": [
                [
                  "Automated",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_722e4ce4917e4ffea4a1c7c941308cb3": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_b40db168972b492e99e7453d444d1ffb": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_c158846e07514b70b11ae38883f75373": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_4f25e825fa4a48d3bbc7321813f05417": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_21981b1d7cff46db9e692612395444f2": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_e699abdd21e84c1998034b995263c43c": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_40bbd0783f144862a33a4d6e84c174d4": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_37214f692ed9481dadff5fd08e952d56": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f2f2634ba56a41e5bb0b1af1c464206c": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
hostPool:
{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_Update (updated)
Description Update a host pool.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_Update",
  "$parameters": [
    {
      "#name": "hostPool",
      "Description": {
        "new": "The properties to be updated.",
        "old": "Object containing HostPool definitions."
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "personalDesktopAssignmentType",
              "Enum": {
                "new": [
                  [
                    "Automatic",
                    "Automatically assigns an available personal desktop to the user."
                  ],
                  [
                    "Direct",
                    "Manually assigns a specific personal desktop to the user."
                  ]
                ],
                "old": [
                  [
                    "Automatic",
                    ""
                  ],
                  [
                    "Direct",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "loadBalancerType",
              "Enum": {
                "new": [
                  [
                    "BreadthFirst",
                    "Uses BreadthFirst algorithm for load balancing."
                  ],
                  [
                    "DepthFirst",
                    "Uses DepthFirst algorithm for load balancing."
                  ],
                  [
                    "Persistent",
                    "Maintains persistent connections."
                  ],
                  [
                    "MultiplePersistent",
                    "Maintains multiple persistents connections."
                  ]
                ],
                "old": [
                  [
                    "BreadthFirst",
                    ""
                  ],
                  [
                    "DepthFirst",
                    ""
                  ],
                  [
                    "Persistent",
                    ""
                  ],
                  [
                    "MultiplePersistent",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "registrationInfo",
              "Description": {
                "new": "The registration info of HostPool.",
                "old": "The registration info of HostPool.  This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
              },
              "$properties": [
                {
                  "#name": "registrationTokenOperation",
                  "Enum": {
                    "new": [
                      [
                        "Delete",
                        "Delete operation"
                      ],
                      [
                        "None",
                        "No Operation"
                      ],
                      [
                        "Update",
                        "Update Operation"
                      ]
                    ],
                    "old": [
                      [
                        "Delete",
                        ""
                      ],
                      [
                        "None",
                        ""
                      ],
                      [
                        "Update",
                        ""
                      ]
                    ]
                  }
                }
              ]
            },
            {
              "#name": "ssoSecretType",
              "Enum": {
                "new": [
                  [
                    "SharedKey",
                    "The SSO Secret is a Shared Key."
                  ],
                  [
                    "Certificate",
                    "The SSO Secret is a Certificate."
                  ],
                  [
                    "SharedKeyInKeyVault",
                    "The SSO Secret is a SharedKey that is stored in KeyVault."
                  ],
                  [
                    "CertificateInKeyVault",
                    "The SSO Secret is a Certificate that is stored in KeyVault."
                  ]
                ],
                "old": [
                  [
                    "SharedKey",
                    ""
                  ],
                  [
                    "Certificate",
                    ""
                  ],
                  [
                    "SharedKeyInKeyVault",
                    ""
                  ],
                  [
                    "CertificateInKeyVault",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "preferredAppGroupType",
              "Enum": {
                "new": [
                  [
                    "None",
                    "Internal Use Only"
                  ],
                  [
                    "Desktop",
                    "Use Desktop Application Group"
                  ],
                  [
                    "RailApplications",
                    "Use RailApplications (RemoteApp)"
                  ]
                ],
                "old": [
                  [
                    "None",
                    "This value is read only, it is not accepted on input."
                  ],
                  [
                    "Desktop",
                    "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                  ],
                  [
                    "RailApplications",
                    "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                  ]
                ]
              }
            },
            {
              "#name": "publicNetworkAccess",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "Allows this resource to be accessed from the public network"
                  ],
                  [
                    "Disabled",
                    "Prevents this resource from being accessed from the public network"
                  ],
                  [
                    "EnabledForSessionHostsOnly",
                    "Allows SessionHosts to be accessed from the public network"
                  ],
                  [
                    "EnabledForClientsOnly",
                    "Allows Clients to be accessed from the public network"
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ],
                  [
                    "EnabledForSessionHostsOnly",
                    ""
                  ],
                  [
                    "EnabledForClientsOnly",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "managedPrivateUDP",
              "Enum": {
                "new": [
                  [
                    "Default",
                    "AVD-wide settings are used to determine connection availability"
                  ],
                  [
                    "Enabled",
                    "UDP will attempt this connection type when making connections."
                  ],
                  [
                    "Disabled",
                    "UDP will not attempt this connection type when making connections"
                  ]
                ],
                "old": [
                  [
                    "Default",
                    ""
                  ],
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "directUDP",
              "Enum": {
                "new": [
                  [
                    "Default",
                    "AVD-wide settings are used to determine connection availability"
                  ],
                  [
                    "Enabled",
                    "UDP will attempt this connection type when making connections."
                  ],
                  [
                    "Disabled",
                    "UDP will not attempt this connection type when making connections"
                  ]
                ],
                "old": [
                  [
                    "Default",
                    ""
                  ],
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "publicUDP",
              "Enum": {
                "new": [
                  [
                    "Default",
                    "AVD-wide settings are used to determine connection availability"
                  ],
                  [
                    "Enabled",
                    "UDP will attempt this connection type when making connections."
                  ],
                  [
                    "Disabled",
                    "UDP will not attempt this connection type when making connections"
                  ]
                ],
                "old": [
                  [
                    "Default",
                    ""
                  ],
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "relayUDP",
              "Enum": {
                "new": [
                  [
                    "Default",
                    "AVD-wide settings are used to determine connection availability"
                  ],
                  [
                    "Enabled",
                    "UDP will attempt this connection type when making connections."
                  ],
                  [
                    "Disabled",
                    "UDP will not attempt this connection type when making connections"
                  ]
                ],
                "old": [
                  [
                    "Default",
                    ""
                  ],
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "personalDesktopAssignmentType",
            "Enum": {
              "new": [
                [
                  "Automatic",
                  "Automatically assigns an available personal desktop to the user."
                ],
                [
                  "Direct",
                  "Manually assigns a specific personal desktop to the user."
                ]
              ],
              "old": [
                [
                  "Automatic",
                  ""
                ],
                [
                  "Direct",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "loadBalancerType",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Uses BreadthFirst algorithm for load balancing."
                ],
                [
                  "DepthFirst",
                  "Uses DepthFirst algorithm for load balancing."
                ],
                [
                  "Persistent",
                  "Maintains persistent connections."
                ],
                [
                  "MultiplePersistent",
                  "Maintains multiple persistents connections."
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ],
                [
                  "Persistent",
                  ""
                ],
                [
                  "MultiplePersistent",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "registrationInfo",
            "Description": {
              "new": "The registration info of HostPool.",
              "old": "The registration info of HostPool. This is not returned on GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
            },
            "$properties": [
              {
                "#name": "registrationTokenOperation",
                "Enum": {
                  "new": [
                    [
                      "Delete",
                      "Delete operation"
                    ],
                    [
                      "None",
                      "No Operation"
                    ],
                    [
                      "Update",
                      "Update Operation"
                    ]
                  ],
                  "old": [
                    [
                      "Delete",
                      ""
                    ],
                    [
                      "None",
                      ""
                    ],
                    [
                      "Update",
                      ""
                    ]
                  ]
                }
              }
            ]
          },
          {
            "#name": "ssoSecretType",
            "Enum": {
              "new": [
                [
                  "SharedKey",
                  "The SSO Secret is a Shared Key."
                ],
                [
                  "Certificate",
                  "The SSO Secret is a Certificate."
                ],
                [
                  "SharedKeyInKeyVault",
                  "The SSO Secret is a SharedKey that is stored in KeyVault."
                ],
                [
                  "CertificateInKeyVault",
                  "The SSO Secret is a Certificate that is stored in KeyVault."
                ]
              ],
              "old": [
                [
                  "SharedKey",
                  ""
                ],
                [
                  "Certificate",
                  ""
                ],
                [
                  "SharedKeyInKeyVault",
                  ""
                ],
                [
                  "CertificateInKeyVault",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "preferredAppGroupType",
            "Enum": {
              "new": [
                [
                  "None",
                  "Internal Use Only"
                ],
                [
                  "Desktop",
                  "Use Desktop Application Group"
                ],
                [
                  "RailApplications",
                  "Use RailApplications (RemoteApp)"
                ]
              ],
              "old": [
                [
                  "None",
                  "This value is read only, it is not accepted on input."
                ],
                [
                  "Desktop",
                  "Users access the full Windows desktop from a session host. Available with pooled or personal host pools."
                ],
                [
                  "RailApplications",
                  "Users access individual applications you select and publish to the application group. Available with pooled host pools only."
                ]
              ]
            }
          },
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "Allows this resource to be accessed from the public network"
                ],
                [
                  "Disabled",
                  "Prevents this resource from being accessed from the public network"
                ],
                [
                  "EnabledForSessionHostsOnly",
                  "Allows SessionHosts to be accessed from the public network"
                ],
                [
                  "EnabledForClientsOnly",
                  "Allows Clients to be accessed from the public network"
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ],
                [
                  "EnabledForSessionHostsOnly",
                  ""
                ],
                [
                  "EnabledForClientsOnly",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          },
          {
            "#name": "managedPrivateUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "directUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "publicUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "relayUDP",
            "Enum": {
              "new": [
                [
                  "Default",
                  "AVD-wide settings are used to determine connection availability"
                ],
                [
                  "Enabled",
                  "UDP will attempt this connection type when making connections."
                ],
                [
                  "Disabled",
                  "UDP will not attempt this connection type when making connections"
                ]
              ],
              "old": [
                [
                  "Default",
                  ""
                ],
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "managementType",
            "Enum": {
              "new": [
                [
                  "Automated",
                  "Automated management of the hostpool"
                ],
                [
                  "Standard",
                  "Standard management of the hostpool"
                ]
              ],
              "old": [
                [
                  "Automated",
                  ""
                ],
                [
                  "Standard",
                  ""
                ]
              ]
            }
          }
        ],
        "@added_a94477692c344c60948d3bafdc9d3921": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_093782c2a5c5401e956165df2df3e6be": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_4096f164c89b4a6f928c05c54c5bad5f": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_6925bf7748bc4e5da2b5f40582d82d20": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_3f9931cf07654188943e5831e08d7f6d": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_821b1a659259483ab8a553c696bee6f6": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_fa41864349bb4aaa8751aab60df3c0ec": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b3732d6eaa0b4e62b1c2e4274f6710ff": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_2d4b43231b2a452dbf79c60d68ee98de": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
hostPool:
{
tags: object ,
properties:
{
friendlyName: string ,
description: string ,
customRdpProperty: string ,
maxSessionLimit: integer ,
personalDesktopAssignmentType: enum ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
friendlyName: string ,
description: string ,
hostPoolType: enum ,
personalDesktopAssignmentType: enum ,
customRdpProperty: string ,
maxSessionLimit: integer ,
loadBalancerType: enum ,
ring: integer ,
validationEnvironment: boolean ,
registrationInfo:
{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}
,
vmTemplate: string ,
applicationGroupReferences:
[
string ,
]
,
appAttachPackageReferences:
[
string ,
]
,
ssoadfsAuthority: string ,
ssoClientId: string ,
ssoClientSecretKeyVaultPath: string ,
ssoSecretType: enum ,
preferredAppGroupType: enum ,
startVMOnConnect: boolean ,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
agentUpdate:
{
type: enum ,
useSessionHostLocalTime: boolean ,
maintenanceWindowTimeZone: string ,
maintenanceWindows:
[
{
hour: integer ,
dayOfWeek: enum ,
}
,
]
,
}
,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
managedPrivateUDP: enum ,
directUDP: enum ,
publicUDP: enum ,
relayUDP: enum ,
managementType: enum ,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_Delete (updated)
Description Remove a host pool.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_e34a21cf496a4d73953acd0992235eae": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_a85c31404d08440982fd12b3ca78a2d8": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_25047662c1f24eafbf1bcbc5e5341f97": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
force: boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ActiveSessionHostConfigurations_ListByHostPool (updated)
Description Operation to list the ActiveSessionHostConfigurations associated with the HostPool
Reference Link ¶

⚶ Changes

{
  "#id": "ActiveSessionHostConfigurations_ListByHostPool",
  "Description": {
    "new": "Operation to list the ActiveSessionHostConfigurations associated with the HostPool",
    "old": "List activeSessionHostConfigurations."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ActiveSessionHostConfiguration items on this page",
            "old": "List of ActiveSessionHostConfiguration definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Schema for ActiveSessionHostConfiguration properties.",
              "old": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState"
            },
            "$properties": [
              {
                "#name": "properties",
                "Description": {
                  "new": "Detailed properties for ActiveSessionHostConfiguration",
                  "old": "Detailed properties for SessionHostConfiguration"
                },
                "$properties": [
                  {
                    "#name": "friendlyName",
                    "Description": {
                      "new": "Friendly name to describe this version of the SessionHostConfiguration",
                      "old": "Friendly name to describe this version of the SessionHostConfiguration."
                    }
                  },
                  {
                    "#name": "imageInfo",
                    "Description": {
                      "new": "Image configurations of the HostPool.",
                      "old": "Image configurations of HostPool."
                    },
                    "$properties": {
                      "marketplaceInfo": [
                        {
                          "#name": "sku",
                          "Description": {
                            "new": "The SKU of the image.",
                            "old": "The sku of the image."
                          }
                        },
                        {
                          "#name": "exactVersion",
                          "Description": {
                            "new": "The version of the image.",
                            "old": "The exact version of the image."
                          }
                        }
                      ],
                      "customInfo": [
                        {
                          "#name": "resourceId",
                          "Description": {
                            "new": "The resource ID of the image.",
                            "old": "The resource id of the custom image."
                          }
                        }
                      ]
                    }
                  },
                  {
                    "securityInfo": [
                      {
                        "#name": "type",
                        "Enum": {
                          "new": [
                            [
                              "Standard",
                              "Standard security protocol. No additional parameters"
                            ],
                            [
                              "TrustedLaunch",
                              "TrustedLaunch allows for secure boot and vTpm"
                            ],
                            [
                              "ConfidentialVM",
                              "Confidential Virtual Machine security protocol"
                            ]
                          ],
                          "old": [
                            [
                              "Standard",
                              "Standard security protocol. No additional parameters"
                            ],
                            [
                              "TrustedLaunch",
                              "TrustedLaunch allows for secure boot adn vTPM"
                            ],
                            [
                              "ConfidentialVM",
                              "Confidential Virtual Machine security protocol"
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "vTpmEnabled",
                        "Description": {
                          "new": "Whether to use vTpm on the virtual machine.",
                          "old": "Whether to use vTPM on the virtual machine."
                        }
                      }
                    ]
                  }
                ]
              }
            ]
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_fd4b5df406ca402ba09eb92e6bb3b6b0": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_4cca9ad3970e4580931a8d0db48b837e": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f56f0906869a4556b1c9d7e5de26123c": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
version: string ,
friendlyName: string ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ActiveSessionHostConfigurations_Get (updated)
Description Get a ActiveSessionHostConfiguration.
Reference Link ¶

⚶ Changes

{
  "#id": "ActiveSessionHostConfigurations_Get",
  "Description": {
    "new": "Get a ActiveSessionHostConfiguration.",
    "old": "Get the ActiveSessionHostConfiguration for the hostPool that is currently being used for update operations."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for ActiveSessionHostConfiguration properties.",
        "old": "Represents a ActiveSessionHostConfiguration definition. This has all of the sessionHostConfiguration properties except provisioningState"
      },
      "$properties": [
        {
          "#name": "properties",
          "Description": {
            "new": "Detailed properties for ActiveSessionHostConfiguration",
            "old": "Detailed properties for SessionHostConfiguration"
          },
          "$properties": [
            {
              "#name": "friendlyName",
              "Description": {
                "new": "Friendly name to describe this version of the SessionHostConfiguration",
                "old": "Friendly name to describe this version of the SessionHostConfiguration."
              }
            },
            {
              "#name": "imageInfo",
              "Description": {
                "new": "Image configurations of the HostPool.",
                "old": "Image configurations of HostPool."
              },
              "$properties": {
                "marketplaceInfo": [
                  {
                    "#name": "sku",
                    "Description": {
                      "new": "The SKU of the image.",
                      "old": "The sku of the image."
                    }
                  },
                  {
                    "#name": "exactVersion",
                    "Description": {
                      "new": "The version of the image.",
                      "old": "The exact version of the image."
                    }
                  }
                ],
                "customInfo": [
                  {
                    "#name": "resourceId",
                    "Description": {
                      "new": "The resource ID of the image.",
                      "old": "The resource id of the custom image."
                    }
                  }
                ]
              }
            },
            {
              "securityInfo": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot and vTpm"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ],
                    "old": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot adn vTPM"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ]
                  }
                },
                {
                  "#name": "vTpmEnabled",
                  "Description": {
                    "new": "Whether to use vTpm on the virtual machine.",
                    "old": "Whether to use vTPM on the virtual machine."
                  }
                }
              ]
            }
          ]
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_e2604ac7dd944ed1b43ea1519d94bcce": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_9374f01584af47f8b8645d8ec5f60cd8": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_83d4aa1d036640928225f61b14ee211b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/activeSessionHostConfigurations/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
properties:
{
version: string ,
friendlyName: string ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
MsixImages_Expand (updated)
Description Expands and Lists MSIX packages in an Image, given the Image Path. This action uses incorrect Msix casing intentionally to match the previous APIs.
Reference Link ¶

⚶ Changes

{
  "#id": "MsixImages_Expand",
  "Description": {
    "new": "Expands and Lists MSIX packages in an Image, given the Image Path.\nThis action uses incorrect Msix casing intentionally to match the previous APIs.",
    "old": "Expands and Lists MSIX packages in an Image, given the Image Path."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ExpandMsixImage items on this page",
            "old": "List of MSIX package properties from give MSIX Image."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Represents the definition of contents retrieved after expanding the MSIX Image.",
              "old": "Represents the definition of contents retrieved after expanding the MSIX Image. "
            },
            "$properties": {
              "properties": [
                {
                  "#name": "packageName",
                  "Description": {
                    "new": "Package Name from appxmanifest.xml.",
                    "old": "Package Name from appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageFamilyName",
                  "Description": {
                    "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                    "old": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name. "
                  }
                },
                {
                  "#name": "packageFullName",
                  "Description": {
                    "new": "Package Full Name from appxmanifest.xml.",
                    "old": "Package Full Name from appxmanifest.xml. "
                  }
                },
                {
                  "#name": "displayName",
                  "Description": {
                    "new": "User friendly Name to be displayed in the portal.",
                    "old": "User friendly Name to be displayed in the portal. "
                  }
                },
                {
                  "#name": "packageRelativePath",
                  "Description": {
                    "new": "Relative Path to the package inside the image.",
                    "old": "Relative Path to the package inside the image. "
                  }
                },
                {
                  "#name": "isActive",
                  "Description": {
                    "new": "Make this version of the package the active one across the hostpool.",
                    "old": "Make this version of the package the active one across the hostpool. "
                  }
                },
                {
                  "#name": "packageDependencies",
                  "Description": {
                    "new": "List of package dependencies.",
                    "old": "List of package dependencies. "
                  },
                  "$items": {
                    "$properties": [
                      {
                        "#name": "dependencyName",
                        "Description": {
                          "new": "Name of package dependency.",
                          "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                        }
                      }
                    ]
                  }
                },
                {
                  "#name": "version",
                  "Description": {
                    "new": "Package version found in the appxmanifest.xml.",
                    "old": "Package Version found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "lastUpdated",
                  "Description": {
                    "new": "Date Package was last updated, found in the appxmanifest.xml.",
                    "old": "Date Package was last updated, found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "packageApplications",
                  "Description": {
                    "new": "List of package applications.",
                    "old": "List of package applications. "
                  }
                },
                {
                  "#name": "certificateName",
                  "Description": {
                    "new": "Certificate name found in the appxmanifest.xml.",
                    "old": "Certificate name found in the appxmanifest.xml. "
                  }
                },
                {
                  "#name": "certificateExpiry",
                  "Description": {
                    "new": "Date certificate expires, found in the appxmanifest.xml.",
                    "old": "Date certificate expires, found in the appxmanifest.xml. "
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f2722bf7bb2946fc8987f0de86f44c2c": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_78a691831d294ea285d07bf82bff1dce": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_81ad3cfc1db54d0ca2a76c041fa10679": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/expandMsixImage
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
msixImageURI:
{
uri: string ,
}
,
}

⚐ Response (200)

{
value:
[
{
properties:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
AppAttachPackageInfo_Import (updated)
Description Gets information from a package given the path to the package.
Reference Link ¶

⚶ Changes

{
  "#id": "AppAttachPackageInfo_Import",
  "$parameters": {
    "importPackageInfoRequest": {
      "$properties": [
        {
          "#name": "packageArchitecture",
          "Enum": {
            "new": [
              [
                "ARM",
                "ARM 32-bit"
              ],
              [
                "ARM64",
                "ARM 64-bit"
              ],
              [
                "x86",
                "32-bit x86"
              ],
              [
                "x64",
                "64-bit"
              ],
              [
                "Neutral",
                "Any architecture can be used"
              ],
              [
                "x86a64",
                "X86 Compiled Hybrid Portable Executable for ARM64"
              ],
              [
                "ALL",
                "Select all listed applications, no filters"
              ]
            ],
            "old": [
              [
                "ARM",
                ""
              ],
              [
                "ARM64",
                ""
              ],
              [
                "x86",
                ""
              ],
              [
                "x64",
                ""
              ],
              [
                "Neutral",
                ""
              ],
              [
                "x86a64",
                ""
              ],
              [
                "ALL",
                ""
              ]
            ]
          }
        }
      ]
    }
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The AppAttachPackage items on this page",
            "old": "List of App Attach Package definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Succeeded",
                        "Provisioning Successful"
                      ],
                      [
                        "Provisioning",
                        "Provisioning in Progress"
                      ],
                      [
                        "Failed",
                        "Provisioning Failed"
                      ],
                      [
                        "Canceled",
                        "Provisioning was Canceled"
                      ]
                    ],
                    "old": [
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Provisioning",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "image": [
                    {
                      "#name": "imagePath",
                      "Description": {
                        "new": "VHD/CIM image path on Network Share.",
                        "old": "VHD/CIM/APP-V image path on Network Share."
                      }
                    },
                    {
                      "#name": "packageName",
                      "Description": {
                        "new": "Package Name from appxmanifest.xml.",
                        "old": "Package Name from appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageFamilyName",
                      "Description": {
                        "new": "Package Family Name from appxmanifest.xml. Contains Package Name and Publisher name.",
                        "old": "Identifier not including the package version, for Msix packages it is the family name from the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageFullName",
                      "Description": {
                        "new": "Package Full Name from appxmanifest.xml.",
                        "old": "Identifier including the package version, for Msix packages it is the full name from the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "displayName",
                      "Description": {
                        "new": "User friendly Name to be displayed in the portal.",
                        "old": "User friendly Name to be displayed in the portal. "
                      }
                    },
                    {
                      "#name": "packageRelativePath",
                      "Description": {
                        "new": "Relative Path to the package inside the image.",
                        "old": "Relative Path to the package inside the image. "
                      }
                    },
                    {
                      "#name": "isActive",
                      "Description": {
                        "new": "Make this version of the package the active one across the hostpool.",
                        "old": "Make this version of the package the active one across the hostpool. "
                      }
                    },
                    {
                      "#name": "packageDependencies",
                      "Description": {
                        "new": "List of package dependencies.",
                        "old": "List of package dependencies. "
                      },
                      "$items": {
                        "$properties": [
                          {
                            "#name": "dependencyName",
                            "Description": {
                              "new": "Name of package dependency.",
                              "old": "Name of the package dependency. For Msix packages, this is the other packages this package depends upon, for APP-V packages this is the locations of the user and deployment config files"
                            }
                          }
                        ]
                      }
                    },
                    {
                      "#name": "version",
                      "Description": {
                        "new": "Package version found in the appxmanifest.xml.",
                        "old": "Package Version found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "lastUpdated",
                      "Description": {
                        "new": "Date Package was last updated, found in the appxmanifest.xml.",
                        "old": "Date the package source was last updated, for Msix packages this is found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "packageApplications",
                      "Description": {
                        "new": "List of package applications.",
                        "old": "List of package applications. "
                      }
                    },
                    {
                      "#name": "certificateName",
                      "Description": {
                        "new": "Certificate name found in the appxmanifest.xml.",
                        "old": "Certificate name found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "certificateExpiry",
                      "Description": {
                        "new": "Date certificate expires, found in the appxmanifest.xml.",
                        "old": "Date certificate expires, found in the appxmanifest.xml. "
                      }
                    },
                    {
                      "#name": "isPackageTimestamped",
                      "Enum": {
                        "new": [
                          [
                            "Timestamped",
                            "Package is timestamped"
                          ],
                          [
                            "NotTimestamped",
                            "Package is not timestamped, use certificate expiry date"
                          ]
                        ],
                        "old": [
                          [
                            "Timestamped",
                            ""
                          ],
                          [
                            "NotTimestamped",
                            ""
                          ]
                        ]
                      }
                    }
                  ]
                },
                {
                  "#name": "keyVaultURL",
                  "Description": {
                    "new": "URL path to certificate name located in keyVault",
                    "old": "URL of keyvault location to store certificate"
                  }
                },
                {
                  "#name": "failHealthCheckOnStagingFailure",
                  "Enum": {
                    "new": [
                      [
                        "Unhealthy",
                        "Health Check will report unhealthy"
                      ],
                      [
                        "NeedsAssistance",
                        "Health Check will report NeedsAssistance"
                      ],
                      [
                        "DoNotFail",
                        "Health Check will not report failure"
                      ]
                    ],
                    "old": [
                      [
                        "Unhealthy",
                        ""
                      ],
                      [
                        "NeedsAssistance",
                        ""
                      ],
                      [
                        "DoNotFail",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/importAppAttachPackageInfo
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
importPackageInfoRequest:
{
path: string ,
packageArchitecture: enum ,
}
,
}

⚐ Response (200)

{
value:
[
{
properties:
{
provisioningState: enum ,
image:
{
packageAlias: string ,
imagePath: string ,
packageName: string ,
packageFamilyName: string ,
packageFullName: string ,
displayName: string ,
packageRelativePath: string ,
isRegularRegistration: boolean ,
isActive: boolean ,
packageDependencies:
[
{
dependencyName: string ,
publisher: string ,
minVersion: string ,
}
,
]
,
version: string ,
lastUpdated: string ,
packageApplications:
[
{
appId: string ,
description: string ,
appUserModelID: string ,
friendlyName: string ,
iconImageName: string ,
rawIcon: string ,
rawPng: string ,
}
,
]
,
certificateName: string ,
certificateExpiry: string ,
isPackageTimestamped: enum ,
}
,
hostPoolReferences:
[
string ,
]
,
keyVaultURL: string ,
failHealthCheckOnStagingFailure: enum ,
packageOwnerName: string ,
packageLookbackUrl: string ,
customData: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
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."
  },
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_320d9db712f449cfbd42aa060c64e286": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b2087e96eb3f4d999d9c79c3c3336897": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f41530165810485dbafb616e550ef0d7": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/listRegistrationTokens
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
value:
[
{
expirationTime: string ,
token: string ,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByHostPool (updated)
Description Get a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByHostPool",
  "Description": {
    "new": "Get a PrivateEndpointConnectionWithSystemData",
    "old": "List private endpoint connections associated with hostpool."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of private endpoint connection associated with the specified HostPool",
        "old": "List of private endpoint connection associated with the specified storage account"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnectionWithSystemData items on this page",
            "old": "Array of private endpoint connections"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_6036565a26334a6dbaa3582a944fadf7": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_a52be850b4ae477fb75e62aaf433a279": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_875cd5075f964d16ba23a0e8bdea70f0": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_GetByHostPool (updated)
Description Get a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_GetByHostPool",
  "Description": {
    "new": "Get a PrivateEndpointConnectionWithSystemData",
    "old": "Get a private endpoint connection."
  },
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name parameter for private endpoint",
        "old": "The name of the private endpoint connection associated with the Azure resource."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_731baf82abf342dc92603a21434a38b2": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_9a0026908d8743d8831851692ea054f8": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_476abb655aee45a990a635e1e1c71652": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_UpdateByHostPool (updated)
Description Create a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_UpdateByHostPool",
  "Description": {
    "new": "Create a PrivateEndpointConnectionWithSystemData",
    "old": "Approve or reject a private endpoint connection."
  },
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name parameter for private endpoint",
        "old": "The name of the private endpoint connection associated with the Azure resource."
      }
    },
    {
      "#name": "connection",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Object containing the updated connection."
      },
      "$schema": {
        "Description": {
          "new": "The Private Endpoint Connection resource.",
          "old": "The private endpoint connection resource."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "The resource-specific properties for this resource.",
              "old": "Resource properties."
            },
            "$properties": [
              {
                "privateLinkServiceConnectionState": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Pending",
                          "Connection is Pending"
                        ],
                        [
                          "Approved",
                          "Connection was Approved"
                        ],
                        [
                          "Rejected",
                          "Connection was rejected"
                        ]
                      ],
                      "old": [
                        [
                          "Pending",
                          ""
                        ],
                        [
                          "Approved",
                          ""
                        ],
                        [
                          "Rejected",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "Succeeded",
                      "Provisioning was successful"
                    ],
                    [
                      "Creating",
                      "A PrivateEndpointConnection is being created"
                    ],
                    [
                      "Deleting",
                      "A PrivateEndpointConnection is being deleted"
                    ],
                    [
                      "Failed",
                      "Provisioning failed"
                    ]
                  ],
                  "old": [
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "Creating",
                      ""
                    ],
                    [
                      "Deleting",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "@added_c089564197c24a9e850e5e08875c4ca5": {
      "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"
              }
            ]
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_9e0b5117ddea4b4fba1eb6febc8bd6ce": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_8a48fe8ee0da48a2b7b9818b1b333cfb": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_5e25e97ad14f4d3694d0b83d7d9dd582": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
privateEndpointConnectionName: string ,
connection:
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_DeleteByHostPool (updated)
Description Delete a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_DeleteByHostPool",
  "Description": {
    "new": "Delete a PrivateEndpointConnectionWithSystemData",
    "old": "Remove a connection."
  },
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name parameter for private endpoint",
        "old": "The name of the private endpoint connection associated with the Azure resource."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_ea893f3184d84b90b81556284e9dad84": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_695723e0096d4974b7ad719c266af572": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_5a6157331c4c40b5b3cc6e741c9428d1": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByHostPool (updated)
Description List the private link resources available for this hostpool.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByHostPool",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "Array of private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f179cdebb36140bb85640424c607998b": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_0db7ab3d60d544c6a6636a3b026ba5cd": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_758da1b4ac374598851445d9d25baae1": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/privateLinkResources
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
HostPools_RetrieveRegistrationToken (updated)
Description Registration token of the host pool.
Reference Link ¶

⚶ Changes

{
  "#id": "HostPools_RetrieveRegistrationToken",
  "$responses": {
    "200": {
      "Description": {
        "new": "Represents a RegistrationInfo definition.",
        "old": "Represents a RegistrationInfo definition.  This is not returned on HostPool GET. In order to get the registration token use the retrieveRegistrationToken or listRegistrationTokens POST calls."
      },
      "$properties": [
        {
          "#name": "registrationTokenOperation",
          "Enum": {
            "new": [
              [
                "Delete",
                "Delete operation"
              ],
              [
                "None",
                "No Operation"
              ],
              [
                "Update",
                "Update Operation"
              ]
            ],
            "old": [
              [
                "Delete",
                ""
              ],
              [
                "None",
                ""
              ],
              [
                "Update",
                ""
              ]
            ]
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_dc8b5ef6bf6942dba1f5d5794660ceed": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b5c5967e7301420091c57726ab7b80df": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_17b21ef070444a64ac2b6ea6fdc17c2b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/retrieveRegistrationToken
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
expirationTime: string ,
token: string ,
registrationTokenOperation: enum ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_ListByHostPool (updated)
Description List scaling plan associated with hostpool.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_ListByHostPool",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ScalingPlan items on this page",
            "old": "List of scaling plan definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "schedules",
                  "Description": {
                    "new": "List of ScalingPlanPooledSchedule definitions.",
                    "old": "List of Pooled ScalingSchedule definitions."
                  },
                  "$items": {
                    "$properties": [
                      {
                        "daysOfWeek": {
                          "Description": {
                            "new": "Day of the week. Modeled as string",
                            "old": "Day of the week."
                          },
                          "Enum": {
                            "new": [
                              [
                                "Monday",
                                ""
                              ],
                              [
                                "Tuesday",
                                ""
                              ],
                              [
                                "Wednesday",
                                ""
                              ],
                              [
                                "Thursday",
                                ""
                              ],
                              [
                                "Friday",
                                ""
                              ],
                              [
                                "Saturday",
                                ""
                              ],
                              [
                                "Sunday",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Sunday",
                                ""
                              ],
                              [
                                "Monday",
                                ""
                              ],
                              [
                                "Tuesday",
                                ""
                              ],
                              [
                                "Wednesday",
                                ""
                              ],
                              [
                                "Thursday",
                                ""
                              ],
                              [
                                "Friday",
                                ""
                              ],
                              [
                                "Saturday",
                                ""
                              ]
                            ]
                          }
                        }
                      },
                      {
                        "#name": "rampUpLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "peakLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "rampDownLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "rampDownStopHostsWhen",
                        "Enum": {
                          "new": [
                            [
                              "ZeroSessions",
                              "Zero Total Sessions"
                            ],
                            [
                              "ZeroActiveSessions",
                              "Zero Active Sessions"
                            ]
                          ],
                          "old": [
                            [
                              "ZeroSessions",
                              ""
                            ],
                            [
                              "ZeroActiveSessions",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "offPeakLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              ],
              "@added_0c14ffe865a243d0a4c700400171271c": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_fb0220657c2146cca81c3c1e87ae934d": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_890f6818c018484ead8f62d62059491b": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_d8dc96806f1045908b21d611e4e5c86f": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_0b8f14122df94f8dbc3373dedaba4481": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_82503e3eb21a4119b92ba9c7dc5ef590": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_a9d661c7df854cbe9e0d463c14779c38": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_80aa1a92fcbb456999ae93f05d2c39a8": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_1e577a31d1fa4c45badf9d70138f1973": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/scalingPlans
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHostConfigurations_ListByHostPool (updated)
Description List SessionHostConfigurations.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHostConfigurations_ListByHostPool",
  "Description": {
    "new": "List SessionHostConfigurations.",
    "old": "List sessionHostConfigurations."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SessionHostConfiguration items on this page",
            "old": "List of SessionHostConfiguration definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Schema for SessionHostConfiguration properties.",
              "old": "Represents a SessionHostConfiguration definition."
            },
            "$properties": {
              "properties": [
                {
                  "#name": "provisioningState",
                  "Enum": {
                    "new": [
                      [
                        "Succeeded",
                        "Provisioning Successful"
                      ],
                      [
                        "Failed",
                        "Provisioning Failed"
                      ],
                      [
                        "Canceled",
                        "Provisioning was Canceled"
                      ],
                      [
                        "Provisioning",
                        "Provisioning in Progress"
                      ]
                    ],
                    "old": [
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ],
                      [
                        "Canceled",
                        ""
                      ],
                      [
                        "Provisioning",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "vmLocation",
                  "Description": {
                    "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
                    "old": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
                  }
                },
                {
                  "#name": "diskInfo",
                  "Description": {
                    "new": "Disk Information",
                    "old": "Disk information."
                  }
                },
                {
                  "imageInfo": [
                    {
                      "marketplaceInfo": [
                        {
                          "#name": "sku",
                          "Description": {
                            "new": "The SKU of the image.",
                            "old": "The sku of the image."
                          }
                        },
                        {
                          "#name": "exactVersion",
                          "Description": {
                            "new": "The version of the image.",
                            "old": "The exact version of the image."
                          }
                        }
                      ]
                    },
                    {
                      "customInfo": [
                        {
                          "#name": "resourceId",
                          "Description": {
                            "new": "The resource ID of the image.",
                            "old": "The resource id of the custom image."
                          }
                        }
                      ]
                    }
                  ]
                },
                {
                  "#name": "securityInfo",
                  "Description": {
                    "new": "Security Information",
                    "old": "Security information."
                  },
                  "$properties": [
                    {
                      "#name": "type",
                      "Enum": {
                        "new": [
                          [
                            "Standard",
                            "Standard security protocol. No additional parameters"
                          ],
                          [
                            "TrustedLaunch",
                            "TrustedLaunch allows for secure boot and vTpm"
                          ],
                          [
                            "ConfidentialVM",
                            "Confidential Virtual Machine security protocol"
                          ]
                        ],
                        "old": [
                          [
                            "Standard",
                            "Standard security protocol. No additional parameters"
                          ],
                          [
                            "TrustedLaunch",
                            "TrustedLaunch allows for secure boot adn vTPM"
                          ],
                          [
                            "ConfidentialVM",
                            "Confidential Virtual Machine security protocol"
                          ]
                        ]
                      }
                    },
                    {
                      "#name": "vTpmEnabled",
                      "Description": {
                        "new": "Whether to use vTpm on the virtual machine.",
                        "old": "Whether to use vTPM on the virtual machine."
                      }
                    }
                  ]
                },
                {
                  "#name": "vmAdminCredentials",
                  "Description": {
                    "new": "Local Admin credentials for session hosts.\"",
                    "old": "Local Admin credentials for session hosts."
                  }
                },
                {
                  "#name": "bootDiagnosticsInfo",
                  "Description": {
                    "new": "Boot Diagnostics Information",
                    "old": "Boot Diagnostics information."
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_5cd595968f0c426f8476f53e6fcce62d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_6bb9427c55c440d19cc25faf44fb6054": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_8bca0d90f1004e8fbc9a0ba8f7522d6e": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
version: string ,
friendlyName: string ,
provisioningState: enum ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SessionHostConfigurations_Get",
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for SessionHostConfiguration properties.",
        "old": "Represents a SessionHostConfiguration definition."
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Succeeded",
                  "Provisioning Successful"
                ],
                [
                  "Failed",
                  "Provisioning Failed"
                ],
                [
                  "Canceled",
                  "Provisioning was Canceled"
                ],
                [
                  "Provisioning",
                  "Provisioning in Progress"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "vmLocation",
            "Description": {
              "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
              "old": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
            }
          },
          {
            "#name": "diskInfo",
            "Description": {
              "new": "Disk Information",
              "old": "Disk information."
            }
          },
          {
            "imageInfo": [
              {
                "marketplaceInfo": [
                  {
                    "#name": "sku",
                    "Description": {
                      "new": "The SKU of the image.",
                      "old": "The sku of the image."
                    }
                  },
                  {
                    "#name": "exactVersion",
                    "Description": {
                      "new": "The version of the image.",
                      "old": "The exact version of the image."
                    }
                  }
                ]
              },
              {
                "customInfo": [
                  {
                    "#name": "resourceId",
                    "Description": {
                      "new": "The resource ID of the image.",
                      "old": "The resource id of the custom image."
                    }
                  }
                ]
              }
            ]
          },
          {
            "#name": "securityInfo",
            "Description": {
              "new": "Security Information",
              "old": "Security information."
            },
            "$properties": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Standard",
                      "Standard security protocol. No additional parameters"
                    ],
                    [
                      "TrustedLaunch",
                      "TrustedLaunch allows for secure boot and vTpm"
                    ],
                    [
                      "ConfidentialVM",
                      "Confidential Virtual Machine security protocol"
                    ]
                  ],
                  "old": [
                    [
                      "Standard",
                      "Standard security protocol. No additional parameters"
                    ],
                    [
                      "TrustedLaunch",
                      "TrustedLaunch allows for secure boot adn vTPM"
                    ],
                    [
                      "ConfidentialVM",
                      "Confidential Virtual Machine security protocol"
                    ]
                  ]
                }
              },
              {
                "#name": "vTpmEnabled",
                "Description": {
                  "new": "Whether to use vTpm on the virtual machine.",
                  "old": "Whether to use vTPM on the virtual machine."
                }
              }
            ]
          },
          {
            "#name": "vmAdminCredentials",
            "Description": {
              "new": "Local Admin credentials for session hosts.\"",
              "old": "Local Admin credentials for session hosts."
            }
          },
          {
            "#name": "bootDiagnosticsInfo",
            "Description": {
              "new": "Boot Diagnostics Information",
              "old": "Boot Diagnostics information."
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_0d7fa6c4dcf64c4c898f56de5d0e6d94": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_306d09ecd3494124815a69a603bff03b": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_62ce162060fe4816b4acf18280bae070": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
properties:
{
version: string ,
friendlyName: string ,
provisioningState: enum ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SessionHostConfigurations_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "sessionHostConfiguration",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Object containing SessionHostConfiguration definitions."
      },
      "$schema": {
        "Description": {
          "new": "Schema for SessionHostConfiguration properties.",
          "old": "Represents a SessionHostConfiguration definition."
        },
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Succeeded",
                    "Provisioning Successful"
                  ],
                  [
                    "Failed",
                    "Provisioning Failed"
                  ],
                  [
                    "Canceled",
                    "Provisioning was Canceled"
                  ],
                  [
                    "Provisioning",
                    "Provisioning in Progress"
                  ]
                ],
                "old": [
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "vmLocation",
              "Description": {
                "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
                "old": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
              }
            },
            {
              "#name": "diskInfo",
              "Description": {
                "new": "Disk Information",
                "old": "Disk information."
              }
            },
            {
              "imageInfo": [
                {
                  "marketplaceInfo": [
                    {
                      "#name": "sku",
                      "Description": {
                        "new": "The SKU of the image.",
                        "old": "The sku of the image."
                      }
                    },
                    {
                      "#name": "exactVersion",
                      "Description": {
                        "new": "The version of the image.",
                        "old": "The exact version of the image."
                      }
                    }
                  ]
                },
                {
                  "customInfo": [
                    {
                      "#name": "resourceId",
                      "Description": {
                        "new": "The resource ID of the image.",
                        "old": "The resource id of the custom image."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "securityInfo",
              "Description": {
                "new": "Security Information",
                "old": "Security information."
              },
              "$properties": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot and vTpm"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ],
                    "old": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot adn vTPM"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ]
                  }
                },
                {
                  "#name": "vTpmEnabled",
                  "Description": {
                    "new": "Whether to use vTpm on the virtual machine.",
                    "old": "Whether to use vTPM on the virtual machine."
                  }
                }
              ]
            },
            {
              "#name": "vmAdminCredentials",
              "Description": {
                "new": "Local Admin credentials for session hosts.\"",
                "old": "Local Admin credentials for session hosts."
              }
            },
            {
              "#name": "bootDiagnosticsInfo",
              "Description": {
                "new": "Boot Diagnostics Information",
                "old": "Boot Diagnostics information."
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": [
    {
      "200": {
        "Description": {
          "new": "Schema for SessionHostConfiguration properties.",
          "old": "Represents a SessionHostConfiguration definition."
        },
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Succeeded",
                    "Provisioning Successful"
                  ],
                  [
                    "Failed",
                    "Provisioning Failed"
                  ],
                  [
                    "Canceled",
                    "Provisioning was Canceled"
                  ],
                  [
                    "Provisioning",
                    "Provisioning in Progress"
                  ]
                ],
                "old": [
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "vmLocation",
              "Description": {
                "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
                "old": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
              }
            },
            {
              "#name": "diskInfo",
              "Description": {
                "new": "Disk Information",
                "old": "Disk information."
              }
            },
            {
              "imageInfo": [
                {
                  "marketplaceInfo": [
                    {
                      "#name": "sku",
                      "Description": {
                        "new": "The SKU of the image.",
                        "old": "The sku of the image."
                      }
                    },
                    {
                      "#name": "exactVersion",
                      "Description": {
                        "new": "The version of the image.",
                        "old": "The exact version of the image."
                      }
                    }
                  ]
                },
                {
                  "customInfo": [
                    {
                      "#name": "resourceId",
                      "Description": {
                        "new": "The resource ID of the image.",
                        "old": "The resource id of the custom image."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "securityInfo",
              "Description": {
                "new": "Security Information",
                "old": "Security information."
              },
              "$properties": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot and vTpm"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ],
                    "old": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot adn vTPM"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ]
                  }
                },
                {
                  "#name": "vTpmEnabled",
                  "Description": {
                    "new": "Whether to use vTpm on the virtual machine.",
                    "old": "Whether to use vTPM on the virtual machine."
                  }
                }
              ]
            },
            {
              "#name": "vmAdminCredentials",
              "Description": {
                "new": "Local Admin credentials for session hosts.\"",
                "old": "Local Admin credentials for session hosts."
              }
            },
            {
              "#name": "bootDiagnosticsInfo",
              "Description": {
                "new": "Boot Diagnostics Information",
                "old": "Boot Diagnostics information."
              }
            }
          ]
        }
      }
    },
    {
      "#status": "201",
      "$headers": [
        {
          "#name": "azure-asyncoperation",
          "Description": {
            "new": "A link to the status monitor",
            "old": "The URL of the resource used to check the status of the asynchronous operation."
          }
        },
        {
          "@added_27a1e20ae30545beaa57578a803e70fb": {
            "#name": "retry-after",
            "Description": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
            "Type": "integer"
          }
        }
      ],
      "$schema": {
        "Description": {
          "new": "Schema for SessionHostConfiguration properties.",
          "old": "Represents a SessionHostConfiguration definition."
        },
        "$properties": {
          "properties": [
            {
              "#name": "provisioningState",
              "Enum": {
                "new": [
                  [
                    "Succeeded",
                    "Provisioning Successful"
                  ],
                  [
                    "Failed",
                    "Provisioning Failed"
                  ],
                  [
                    "Canceled",
                    "Provisioning was Canceled"
                  ],
                  [
                    "Provisioning",
                    "Provisioning in Progress"
                  ]
                ],
                "old": [
                  [
                    "Succeeded",
                    ""
                  ],
                  [
                    "Failed",
                    ""
                  ],
                  [
                    "Canceled",
                    ""
                  ],
                  [
                    "Provisioning",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "vmLocation",
              "Description": {
                "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
                "old": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
              }
            },
            {
              "#name": "diskInfo",
              "Description": {
                "new": "Disk Information",
                "old": "Disk information."
              }
            },
            {
              "imageInfo": [
                {
                  "marketplaceInfo": [
                    {
                      "#name": "sku",
                      "Description": {
                        "new": "The SKU of the image.",
                        "old": "The sku of the image."
                      }
                    },
                    {
                      "#name": "exactVersion",
                      "Description": {
                        "new": "The version of the image.",
                        "old": "The exact version of the image."
                      }
                    }
                  ]
                },
                {
                  "customInfo": [
                    {
                      "#name": "resourceId",
                      "Description": {
                        "new": "The resource ID of the image.",
                        "old": "The resource id of the custom image."
                      }
                    }
                  ]
                }
              ]
            },
            {
              "#name": "securityInfo",
              "Description": {
                "new": "Security Information",
                "old": "Security information."
              },
              "$properties": [
                {
                  "#name": "type",
                  "Enum": {
                    "new": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot and vTpm"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ],
                    "old": [
                      [
                        "Standard",
                        "Standard security protocol. No additional parameters"
                      ],
                      [
                        "TrustedLaunch",
                        "TrustedLaunch allows for secure boot adn vTPM"
                      ],
                      [
                        "ConfidentialVM",
                        "Confidential Virtual Machine security protocol"
                      ]
                    ]
                  }
                },
                {
                  "#name": "vTpmEnabled",
                  "Description": {
                    "new": "Whether to use vTpm on the virtual machine.",
                    "old": "Whether to use vTPM on the virtual machine."
                  }
                }
              ]
            },
            {
              "#name": "vmAdminCredentials",
              "Description": {
                "new": "Local Admin credentials for session hosts.\"",
                "old": "Local Admin credentials for session hosts."
              }
            },
            {
              "#name": "bootDiagnosticsInfo",
              "Description": {
                "new": "Boot Diagnostics Information",
                "old": "Boot Diagnostics information."
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostConfiguration:
{
properties:
{
version: string ,
friendlyName: string ,
provisioningState: enum ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
version: string ,
friendlyName: string ,
provisioningState: enum ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
azure-asyncoperation: string ,
retry-after: integer ,
}
,
$schema:
{
properties:
{
version: string ,
friendlyName: string ,
provisioningState: enum ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SessionHostConfigurations_Update",
  "$parameters": [
    {
      "#name": "sessionHostConfiguration",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing SessionHostConfiguration definitions."
      },
      "$schema": {
        "Description": {
          "new": "SessionHostConfiguration properties that can be patched.",
          "old": "Represents a SessionHostConfigurationPatch definition."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Detailed properties for SessionHostConfiguration",
              "old": "Detailed properties for SessionHostConfigurationPatch"
            },
            "$properties": [
              {
                "#name": "vmLocation",
                "Description": {
                  "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
                  "old": "The Location for the session host to be created in"
                }
              },
              {
                "#name": "diskInfo",
                "Description": {
                  "new": "Disk Information",
                  "old": "Disk information."
                }
              },
              {
                "imageInfo": [
                  {
                    "marketplaceInfo": [
                      {
                        "#name": "sku",
                        "Description": {
                          "new": "The SKU of the image.",
                          "old": "The sku of the image."
                        }
                      },
                      {
                        "#name": "exactVersion",
                        "Description": {
                          "new": "The version of the image.",
                          "old": "The exact version of the image."
                        }
                      }
                    ]
                  },
                  {
                    "customInfo": [
                      {
                        "#name": "resourceId",
                        "Description": {
                          "new": "The resource ID of the image.",
                          "old": "The resource id of the custom image."
                        }
                      }
                    ]
                  }
                ]
              },
              {
                "#name": "securityInfo",
                "Description": {
                  "new": "Security Information",
                  "old": "Security information."
                },
                "$properties": [
                  {
                    "#name": "type",
                    "Description": {
                      "new": "The security type used by virtual machine in hostpool session host. Default is Standard.",
                      "old": "The security type used by virtual machine in hostpool session host."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Standard",
                          "Standard security protocol. No additional parameters"
                        ],
                        [
                          "TrustedLaunch",
                          "TrustedLaunch allows for secure boot and vTpm"
                        ],
                        [
                          "ConfidentialVM",
                          "Confidential Virtual Machine security protocol"
                        ]
                      ],
                      "old": [
                        [
                          "Standard",
                          "Standard security protocol. No additional parameters"
                        ],
                        [
                          "TrustedLaunch",
                          "TrustedLaunch allows for secure boot adn vTPM"
                        ],
                        [
                          "ConfidentialVM",
                          "Confidential Virtual Machine security protocol"
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "vTpmEnabled",
                    "Description": {
                      "new": "Whether to use vTpm on the virtual machine.",
                      "old": "Whether to use vTPM on the virtual machine."
                    }
                  }
                ]
              },
              {
                "#name": "vmAdminCredentials",
                "Description": {
                  "new": "Local Admin credentials for session hosts.\"",
                  "old": "Local Admin credentials for session hosts."
                }
              },
              {
                "#name": "bootDiagnosticsInfo",
                "Description": {
                  "new": "Boot Diagnostics Information",
                  "old": "Boot Diagnostics information."
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for SessionHostConfiguration properties.",
        "old": "Represents a SessionHostConfiguration definition."
      },
      "$properties": {
        "properties": [
          {
            "#name": "provisioningState",
            "Enum": {
              "new": [
                [
                  "Succeeded",
                  "Provisioning Successful"
                ],
                [
                  "Failed",
                  "Provisioning Failed"
                ],
                [
                  "Canceled",
                  "Provisioning was Canceled"
                ],
                [
                  "Provisioning",
                  "Provisioning in Progress"
                ]
              ],
              "old": [
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ],
                [
                  "Canceled",
                  ""
                ],
                [
                  "Provisioning",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "vmLocation",
            "Description": {
              "new": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided",
              "old": "The Location for the session host to be created in. It will default to the location of the hostpool if not provided."
            }
          },
          {
            "#name": "diskInfo",
            "Description": {
              "new": "Disk Information",
              "old": "Disk information."
            }
          },
          {
            "imageInfo": [
              {
                "marketplaceInfo": [
                  {
                    "#name": "sku",
                    "Description": {
                      "new": "The SKU of the image.",
                      "old": "The sku of the image."
                    }
                  },
                  {
                    "#name": "exactVersion",
                    "Description": {
                      "new": "The version of the image.",
                      "old": "The exact version of the image."
                    }
                  }
                ]
              },
              {
                "customInfo": [
                  {
                    "#name": "resourceId",
                    "Description": {
                      "new": "The resource ID of the image.",
                      "old": "The resource id of the custom image."
                    }
                  }
                ]
              }
            ]
          },
          {
            "#name": "securityInfo",
            "Description": {
              "new": "Security Information",
              "old": "Security information."
            },
            "$properties": [
              {
                "#name": "type",
                "Enum": {
                  "new": [
                    [
                      "Standard",
                      "Standard security protocol. No additional parameters"
                    ],
                    [
                      "TrustedLaunch",
                      "TrustedLaunch allows for secure boot and vTpm"
                    ],
                    [
                      "ConfidentialVM",
                      "Confidential Virtual Machine security protocol"
                    ]
                  ],
                  "old": [
                    [
                      "Standard",
                      "Standard security protocol. No additional parameters"
                    ],
                    [
                      "TrustedLaunch",
                      "TrustedLaunch allows for secure boot adn vTPM"
                    ],
                    [
                      "ConfidentialVM",
                      "Confidential Virtual Machine security protocol"
                    ]
                  ]
                }
              },
              {
                "#name": "vTpmEnabled",
                "Description": {
                  "new": "Whether to use vTpm on the virtual machine.",
                  "old": "Whether to use vTPM on the virtual machine."
                }
              }
            ]
          },
          {
            "#name": "vmAdminCredentials",
            "Description": {
              "new": "Local Admin credentials for session hosts.\"",
              "old": "Local Admin credentials for session hosts."
            }
          },
          {
            "#name": "bootDiagnosticsInfo",
            "Description": {
              "new": "Boot Diagnostics Information",
              "old": "Boot Diagnostics information."
            }
          }
        ]
      }
    },
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds."
        }
      },
      {
        "@removed_076f21616b7d465794a432b629b88038": {
          "#name": "azure-asyncoperation",
          "Description": "The URL of the resource used to check the status of the asynchronous operation.",
          "Type": "string"
        }
      }
    ]
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostConfigurations/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostConfiguration:
{
properties:
{
friendlyName: string ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
version: string ,
friendlyName: string ,
provisioningState: enum ,
vmTags: object ,
vmLocation: string ,
vmResourceGroup: string ,
vmNamePrefix: string ,
availabilityZones:
[
integer ,
]
,
networkInfo:
{
subnetId: string ,
securityGroupId: string ,
}
,
vmSizeId: string ,
diskInfo:
{
type: enum ,
}
,
customConfigurationScriptUrl: string ,
imageInfo:
{
type: enum ,
marketplaceInfo:
{
offer: string ,
publisher: string ,
sku: string ,
exactVersion: string ,
}
,
customInfo:
{
resourceId: string ,
}
,
}
,
domainInfo:
{
joinType: enum ,
activeDirectoryInfo:
{
domainCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
ouPath: string ,
domainName: string ,
}
,
azureActiveDirectoryInfo:
{
mdmProviderGuid: string ,
}
,
}
,
securityInfo:
{
type: enum ,
secureBootEnabled: boolean ,
vTpmEnabled: boolean ,
}
,
vmAdminCredentials:
{
usernameKeyVaultSecretUri: string ,
passwordKeyVaultSecretUri: string ,
}
,
bootDiagnosticsInfo:
{
enabled: boolean ,
storageUri: string ,
}
,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHostManagements_ListByHostPool (updated)
Description List SessionHostManagements.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHostManagements_ListByHostPool",
  "Description": {
    "new": "List SessionHostManagements.",
    "old": "List SessionHostManagements by hostPool."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SessionHostManagement items on this page",
            "old": "List of SessionHostManagement definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "Description": {
              "new": "Schema for SessionHostManagement properties.",
              "old": "Represents a SessionHostManagement definition."
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_5546aeef30c24350819a08b16c08971e": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_1edf87ce090a4950acb1fdfdcc73f43b": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_13c6acad9d324a2a9d38ea7a9342e0a2": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHostManagements_Get (updated)
Description Get a SessionHostManagement.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHostManagements_Get",
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for SessionHostManagement properties.",
        "old": "Represents a SessionHostManagement definition."
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_4b0cc2b0ca9a4a0695be68c204b55334": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_205e731d312242809729ebf0614665dd": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f2b6c0fa688f4f74b76de527ac290f1b": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHostManagements_CreateOrUpdate (updated)
Description Create or update a SessionHostManagement.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHostManagements_CreateOrUpdate",
  "$parameters": [
    {
      "#name": "sessionHostManagement",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Object containing SessionHostManagement definitions."
      },
      "$schema": {
        "Description": {
          "new": "Schema for SessionHostManagement properties.",
          "old": "Represents a SessionHostManagement definition."
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for SessionHostManagement properties.",
        "old": "Represents a SessionHostManagement definition."
      }
    },
    "201": {
      "Description": {
        "new": "Schema for SessionHostManagement properties.",
        "old": "Represents a SessionHostManagement definition."
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_1af1c4b5279c4571bed0bd7a18ab48a3": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_d7d442c8d21f4d4f96ed479a7d7eca84": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_96234287d18b410d88609aaea25ae2b7": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostManagement:
{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}

⚐ Response (201)

{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHostManagements_Update (updated)
Description Update a SessionHostManagement.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHostManagements_Update",
  "$parameters": [
    {
      "#name": "sessionHostManagement",
      "Description": {
        "new": "The properties to be updated.",
        "old": "Object containing SessionHostManagement definitions."
      },
      "$schema": {
        "Description": {
          "new": "SessionHostManagement properties that can be patched.",
          "old": "Represents a SessionHostManagementPatch definition."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "Detailed properties for SessionHostManagement",
              "old": "Detailed properties for SessionHostManagementPatch"
            },
            "$properties": {
              "update": [
                {
                  "#name": "logOffMessage",
                  "Description": {
                    "new": "Log off message sent to user for logoff. Default value is an empty string.",
                    "old": "Log off message sent to user for logoff."
                  }
                }
              ]
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for SessionHostManagement properties.",
        "old": "Represents a SessionHostManagement definition."
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_fc136dcb3a7648d8909e99e6553e9fc6": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_2da9da1886f74f768ec12ce5ba31d2d8": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_a6aab6f8e06c43a1ae4af64e0c33140e": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostManagement:
{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ControlSessionHostUpdate_Post (updated)
Description Control actions on a session host update.
Reference Link ¶

⚶ Changes

{
  "#id": "ControlSessionHostUpdate_Post",
  "Description": {
    "new": "Control actions on a session host update.",
    "old": "Control update of a hostpool."
  },
  "$parameters": [
    {
      "#name": "hostPoolUpdateControlParameter",
      "Description": {
        "new": "The content of the action request",
        "old": "Object containing control action for hostpool update."
      },
      "$schema": {
        "Description": {
          "new": "Object containing control action for hostpool update.",
          "old": "Represents properties for a hostpool update control request."
        },
        "$properties": [
          {
            "#name": "action",
            "Enum": {
              "new": [
                [
                  "Start",
                  "Start the hostpool update."
                ],
                [
                  "Pause",
                  "Pause the hostpool update."
                ],
                [
                  "Cancel",
                  "Cancel the hostpool update."
                ],
                [
                  "Retry",
                  "Retry the hostpool update."
                ],
                [
                  "Resume",
                  "Resume the hostpool update"
                ]
              ],
              "old": [
                [
                  "Start",
                  "Start the hostpool update."
                ],
                [
                  "Pause",
                  "Pause the hostpool update."
                ],
                [
                  "Cancel",
                  "Cancel the hostpool update."
                ],
                [
                  "Retry",
                  "Retry the hostpool update."
                ],
                [
                  "Resume",
                  "Resume the hostpool update."
                ]
              ]
            }
          }
        ]
      }
    }
  ],
  "$responses": {
    "202": [
      {
        "#name": "location",
        "Description": {
          "new": "The Location header contains the URL where the status of the long running operation can be checked.",
          "old": "The URL of the resource used to check the status of the asynchronous operation."
        }
      },
      {
        "#name": "retry-after",
        "Description": {
          "new": "The Retry-After header can indicate how long the client should wait before polling the operation status.",
          "old": "Suggested delay to check the status of the asynchronous operation. The value is an integer that represents the seconds."
        }
      }
    ]
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/controlSessionHostUpdate
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
hostPoolUpdateControlParameter:
{
action: enum ,
cancelMessage: string ,
}
,
}

⚐ Response (202)

{
location: string ,
retry-after: integer ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
InitiateSessionHostUpdate_Post (updated)
Description Initiates a hostpool update or schedule an update for the future.
Reference Link ¶

⚶ Changes

{
  "#id": "InitiateSessionHostUpdate_Post",
  "$parameters": [
    {
      "#name": "updateSessionHostsRequestBody",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing the definition for properties to be used in the sessionHostUpdate validation."
      },
      "$schema": {
        "$properties": {
          "update": [
            {
              "#name": "logOffMessage",
              "Description": {
                "new": "Log off message sent to user for logoff. Default value is an empty string.",
                "old": "Log off message sent to user for logoff."
              }
            }
          ]
        }
      }
    }
  ]
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/initiateSessionHostUpdate
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
updateSessionHostsRequestBody:
{
scheduledDateTime: string ,
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "SessionHostManagementsUpdateStatus_Get",
  "Description": {
    "new": "Get a SessionHostManagementUpdateStatus.",
    "old": "Get the session host update status for a given hostpool."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "Schema for SessionHostManagementUpdateStatus properties.",
        "old": "The current status of the session host update async operation."
      },
      "$properties": [
        {
          "#name": "status",
          "Enum": {
            "new": [
              [
                "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"
              ]
            ],
            "old": []
          }
        },
        {
          "#name": "properties",
          "Description": {
            "new": "Properties bag to hold custom RP properties for sessionHostManagement Update Statuses.",
            "old": "The custom properties of the SessionHost Update Status."
          },
          "$properties": {
            "progress": [
              {
                "#name": "sessionHostsInProgress",
                "Description": {
                  "new": "The number of sessionHosts in progress in the sessionHostManagement operation",
                  "old": "The number of sessionHosts in progress in the sessionHostManagement operation."
                }
              }
            ]
          }
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHostManagements/default/sessionHostUpdateStatuses/default
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
}

⚐ Response (200)

{
id: string ,
name: string ,
percentComplete: number ,
startTime: string ,
endTime: string ,
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
status: enum ,
properties:
{
correlationId: string ,
progress:
{
executionStartTime: string ,
totalSessionHosts: integer ,
sessionHostsInProgress: integer ,
sessionHostsCompleted: integer ,
sessionHostsRollbackFailed: integer ,
}
,
scheduledDateTime: string ,
sessionHostManagement:
{
properties:
{
scheduledDateTimeZone: string ,
update:
{
deleteOriginalVm: boolean ,
maxVmsRemoved: integer ,
logOffDelayMinutes: integer ,
logOffMessage: string ,
}
,
}
,
}
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHosts_List (updated)
Description List sessionHosts.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHosts_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The SessionHost items on this page",
            "old": "List of SessionHost definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "updateState",
                  "Enum": {
                    "new": [
                      [
                        "Initial",
                        "Update is initializing"
                      ],
                      [
                        "Pending",
                        "Update is pending"
                      ],
                      [
                        "Started",
                        "Update has started"
                      ],
                      [
                        "Succeeded",
                        "Update has succeeded"
                      ],
                      [
                        "Failed",
                        "Update has failed"
                      ]
                    ],
                    "old": [
                      [
                        "Initial",
                        ""
                      ],
                      [
                        "Pending",
                        ""
                      ],
                      [
                        "Started",
                        ""
                      ],
                      [
                        "Succeeded",
                        ""
                      ],
                      [
                        "Failed",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "sessionHostHealthCheckResults": {
                    "$properties": [
                      {
                        "#name": "healthCheckName",
                        "Enum": {
                          "new": [
                            [
                              "DomainJoinedCheck",
                              "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)"
                            ],
                            [
                              "DomainTrustCheck",
                              "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)"
                            ],
                            [
                              "FSLogixHealthCheck",
                              "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)"
                            ],
                            [
                              "SxSStackListenerCheck",
                              "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)"
                            ],
                            [
                              "UrlsAccessibleCheck",
                              "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)"
                            ],
                            [
                              "MonitoringAgentCheck",
                              "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)"
                            ],
                            [
                              "DomainReachable",
                              "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)"
                            ],
                            [
                              "WebRTCRedirectorCheck",
                              "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)"
                            ],
                            [
                              "SupportedEncryptionCheck",
                              "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)"
                            ],
                            [
                              "MetaDataServiceCheck",
                              "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)"
                            ],
                            [
                              "AppAttachHealthCheck",
                              "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual de-registration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)"
                            ]
                          ],
                          "old": [
                            [
                              "DomainJoinedCheck",
                              "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)"
                            ],
                            [
                              "DomainTrustCheck",
                              "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)"
                            ],
                            [
                              "FSLogixHealthCheck",
                              "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)"
                            ],
                            [
                              "SxSStackListenerCheck",
                              "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)"
                            ],
                            [
                              "UrlsAccessibleCheck",
                              "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)"
                            ],
                            [
                              "MonitoringAgentCheck",
                              "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)"
                            ],
                            [
                              "DomainReachable",
                              "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)"
                            ],
                            [
                              "WebRTCRedirectorCheck",
                              "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)"
                            ],
                            [
                              "SupportedEncryptionCheck",
                              "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)"
                            ],
                            [
                              "MetaDataServiceCheck",
                              "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)"
                            ],
                            [
                              "AppAttachHealthCheck",
                              "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)"
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_c928cb8c92a349e2b348a34f15c4d4e1": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_f775857536484d7b872ce24bc9188288": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_6845f81380ff4ec9a4fe5eb494c7c043": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
vmPath: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
lastHeartBeat: string ,
sessions: integer ,
agentVersion: string ,
allowNewSession: boolean ,
virtualMachineId: string ,
resourceId: string ,
assignedUser: string ,
friendlyName: string ,
status: enum ,
statusTimestamp: string ,
osVersion: string ,
sxSStackVersion: string ,
updateState: enum ,
lastUpdateTime: string ,
updateErrorMessage: string ,
lastSessionHostUpdateTime: string ,
sessionHostConfiguration: string ,
sessionHostHealthCheckResults:
[
{
healthCheckName: enum ,
healthCheckResult: enum ,
additionalFailureDetails:
{
message: string ,
errorCode: integer ,
lastHealthCheckDateTime: string ,
}
,
}
,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHosts_Get (updated)
Description Get a session host.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHosts_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "updateState",
            "Enum": {
              "new": [
                [
                  "Initial",
                  "Update is initializing"
                ],
                [
                  "Pending",
                  "Update is pending"
                ],
                [
                  "Started",
                  "Update has started"
                ],
                [
                  "Succeeded",
                  "Update has succeeded"
                ],
                [
                  "Failed",
                  "Update has failed"
                ]
              ],
              "old": [
                [
                  "Initial",
                  ""
                ],
                [
                  "Pending",
                  ""
                ],
                [
                  "Started",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          },
          {
            "sessionHostHealthCheckResults": {
              "$properties": [
                {
                  "#name": "healthCheckName",
                  "Enum": {
                    "new": [
                      [
                        "DomainJoinedCheck",
                        "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)"
                      ],
                      [
                        "DomainTrustCheck",
                        "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)"
                      ],
                      [
                        "FSLogixHealthCheck",
                        "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)"
                      ],
                      [
                        "SxSStackListenerCheck",
                        "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)"
                      ],
                      [
                        "UrlsAccessibleCheck",
                        "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)"
                      ],
                      [
                        "MonitoringAgentCheck",
                        "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)"
                      ],
                      [
                        "DomainReachable",
                        "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)"
                      ],
                      [
                        "WebRTCRedirectorCheck",
                        "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)"
                      ],
                      [
                        "SupportedEncryptionCheck",
                        "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)"
                      ],
                      [
                        "MetaDataServiceCheck",
                        "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)"
                      ],
                      [
                        "AppAttachHealthCheck",
                        "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual de-registration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)"
                      ]
                    ],
                    "old": [
                      [
                        "DomainJoinedCheck",
                        "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)"
                      ],
                      [
                        "DomainTrustCheck",
                        "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)"
                      ],
                      [
                        "FSLogixHealthCheck",
                        "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)"
                      ],
                      [
                        "SxSStackListenerCheck",
                        "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)"
                      ],
                      [
                        "UrlsAccessibleCheck",
                        "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)"
                      ],
                      [
                        "MonitoringAgentCheck",
                        "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)"
                      ],
                      [
                        "DomainReachable",
                        "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)"
                      ],
                      [
                        "WebRTCRedirectorCheck",
                        "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)"
                      ],
                      [
                        "SupportedEncryptionCheck",
                        "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)"
                      ],
                      [
                        "MetaDataServiceCheck",
                        "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)"
                      ],
                      [
                        "AppAttachHealthCheck",
                        "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_3c33ceca5eba474c99507e233ac34b6f": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_4f69de416c4a499e91565579155af6a6": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_6740db3034374c50abf7bf5408eb24cf": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
lastHeartBeat: string ,
sessions: integer ,
agentVersion: string ,
allowNewSession: boolean ,
virtualMachineId: string ,
resourceId: string ,
assignedUser: string ,
friendlyName: string ,
status: enum ,
statusTimestamp: string ,
osVersion: string ,
sxSStackVersion: string ,
updateState: enum ,
lastUpdateTime: string ,
updateErrorMessage: string ,
lastSessionHostUpdateTime: string ,
sessionHostConfiguration: string ,
sessionHostHealthCheckResults:
[
{
healthCheckName: enum ,
healthCheckResult: enum ,
additionalFailureDetails:
{
message: string ,
errorCode: integer ,
lastHealthCheckDateTime: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHosts_Update (updated)
Description Update a session host.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHosts_Update",
  "$parameters": [
    {
      "#name": "sessionHost",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing SessionHost definitions."
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "updateState",
            "Enum": {
              "new": [
                [
                  "Initial",
                  "Update is initializing"
                ],
                [
                  "Pending",
                  "Update is pending"
                ],
                [
                  "Started",
                  "Update has started"
                ],
                [
                  "Succeeded",
                  "Update has succeeded"
                ],
                [
                  "Failed",
                  "Update has failed"
                ]
              ],
              "old": [
                [
                  "Initial",
                  ""
                ],
                [
                  "Pending",
                  ""
                ],
                [
                  "Started",
                  ""
                ],
                [
                  "Succeeded",
                  ""
                ],
                [
                  "Failed",
                  ""
                ]
              ]
            }
          },
          {
            "sessionHostHealthCheckResults": {
              "$properties": [
                {
                  "#name": "healthCheckName",
                  "Enum": {
                    "new": [
                      [
                        "DomainJoinedCheck",
                        "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)"
                      ],
                      [
                        "DomainTrustCheck",
                        "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)"
                      ],
                      [
                        "FSLogixHealthCheck",
                        "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)"
                      ],
                      [
                        "SxSStackListenerCheck",
                        "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)"
                      ],
                      [
                        "UrlsAccessibleCheck",
                        "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)"
                      ],
                      [
                        "MonitoringAgentCheck",
                        "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)"
                      ],
                      [
                        "DomainReachable",
                        "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)"
                      ],
                      [
                        "WebRTCRedirectorCheck",
                        "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)"
                      ],
                      [
                        "SupportedEncryptionCheck",
                        "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)"
                      ],
                      [
                        "MetaDataServiceCheck",
                        "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)"
                      ],
                      [
                        "AppAttachHealthCheck",
                        "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual de-registration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)"
                      ]
                    ],
                    "old": [
                      [
                        "DomainJoinedCheck",
                        "Verifies the SessionHost is joined to a domain. If this check fails is classified as fatal as no connection can succeed if the SessionHost is not joined to the domain. (Currently Enabled)"
                      ],
                      [
                        "DomainTrustCheck",
                        "Verifies the SessionHost is not experiencing domain trust issues that will prevent authentication on SessionHost at connection time when session is created. If this check fails is classified as fatal as no connection can succeed if we cannot reach the domain for authentication on the SessionHost. (Currently Enabled)"
                      ],
                      [
                        "FSLogixHealthCheck",
                        "Verifies the FSLogix service is up and running to make sure users' profiles are loaded in the session. If this check fails is classified as fatal as even if the connection can succeed, user experience is bad as the user profile cannot be loaded and user will get a temporary profile in the session. (Currently Disabled)"
                      ],
                      [
                        "SxSStackListenerCheck",
                        "Verifies that the SxS stack is up and running so connections can succeed. If this check fails is classified as fatal as no connection can succeed if the SxS stack is not ready. (Currently Enabled)"
                      ],
                      [
                        "UrlsAccessibleCheck",
                        "Verifies that the required WVD service and Geneva URLs are reachable from the SessionHost. These URLs are: RdTokenUri, RdBrokerURI, RdDiagnosticsUri and storage blob URLs for agent monitoring (geneva). If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is unable to store warm path data (logs, operations ...). (Currently Disabled)"
                      ],
                      [
                        "MonitoringAgentCheck",
                        "Verifies that the required Geneva agent is running. If this check fails, it is non fatal and the machine still can service connections, main issue may be that monitoring agent is missing or running (possibly) older version. (Currently Enabled)"
                      ],
                      [
                        "DomainReachable",
                        "Verifies the domain the SessionHost is joined to is still reachable. If this check fails is classified as fatal as no connection can succeed if the domain the SessionHost is joined is not reachable at the time of connection. (Currently Disabled)"
                      ],
                      [
                        "WebRTCRedirectorCheck",
                        "Verifies whether the WebRTCRedirector component is healthy. The WebRTCRedirector component is used to optimize video and audio performance in Microsoft Teams. This checks whether the component is still running, and whether there is a higher version available. If this check fails, it is non fatal and the machine still can service connections, main issue may be the WebRTCRedirector component has to be restarted or updated. (Currently Disabled)"
                      ],
                      [
                        "SupportedEncryptionCheck",
                        "Verifies the value of SecurityLayer registration key. If the value is 0 (SecurityLayer.RDP) this check fails with Error code = NativeMethodErrorCode.E_FAIL and is fatal. If the value is 1 (SecurityLayer.Negotiate) this check fails with Error code = NativeMethodErrorCode.ERROR_SUCCESS and is non fatal. (Currently Disabled)"
                      ],
                      [
                        "MetaDataServiceCheck",
                        "Verifies the metadata service is accessible and return compute properties. (Currently Enabled)"
                      ],
                      [
                        "AppAttachHealthCheck",
                        "Verifies that the AppAttachService is healthy (there were no issues during package staging). The AppAttachService is used to enable the staging/registration (and eventual deregistration/destaging) of MSIX apps that have been set up by the tenant admin. This checks whether the component had any failures during package staging. Failures in staging will prevent some MSIX apps from working properly for the end user. If this check fails, it is non fatal and the machine still can service connections, main issue may be certain apps will not work for end-users. (Currently Enabled)"
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_27f60d795c0e48889d28553460febf52": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_f2eefa6bccef4c9eb880e970fe5aebfa": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_58b982b08c86466bbd1bac04c70cbfc5": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
force: boolean ,
sessionHost:
{
properties:
{
allowNewSession: boolean ,
assignedUser: string ,
friendlyName: string ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
lastHeartBeat: string ,
sessions: integer ,
agentVersion: string ,
allowNewSession: boolean ,
virtualMachineId: string ,
resourceId: string ,
assignedUser: string ,
friendlyName: string ,
status: enum ,
statusTimestamp: string ,
osVersion: string ,
sxSStackVersion: string ,
updateState: enum ,
lastUpdateTime: string ,
updateErrorMessage: string ,
lastSessionHostUpdateTime: string ,
sessionHostConfiguration: string ,
sessionHostHealthCheckResults:
[
{
healthCheckName: enum ,
healthCheckResult: enum ,
additionalFailureDetails:
{
message: string ,
errorCode: integer ,
lastHealthCheckDateTime: string ,
}
,
}
,
]
,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
SessionHosts_Delete (updated)
Description Remove a SessionHost.
Reference Link ¶

⚶ Changes

{
  "#id": "SessionHosts_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_da7f0fe5d7534c46bdbf49f72ecdcf40": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_424d2af1d620408eb469800a77f46afc": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_7c7d0b1c0ccf4df880d79204b6e84ca9": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
force: boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
UserSessions_List (updated)
Description List userSessions.
Reference Link ¶

⚶ Changes

{
  "#id": "UserSessions_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The UserSession items on this page",
            "old": "List of UserSession definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "applicationType",
                  "Enum": {
                    "new": [
                      [
                        "RemoteApp",
                        "Remote Applications (non-desktop)"
                      ],
                      [
                        "Desktop",
                        "Desktop Applications"
                      ]
                    ],
                    "old": [
                      [
                        "RemoteApp",
                        ""
                      ],
                      [
                        "Desktop",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "sessionState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "SessionState is unknown"
                      ],
                      [
                        "Active",
                        "Session is active"
                      ],
                      [
                        "Disconnected",
                        "Session is disconnected"
                      ],
                      [
                        "Pending",
                        "Session is pending connection"
                      ],
                      [
                        "LogOff",
                        "Session is logging off"
                      ],
                      [
                        "UserProfileDiskMounted",
                        "Session has mounted user profile disk"
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Active",
                        ""
                      ],
                      [
                        "Disconnected",
                        ""
                      ],
                      [
                        "Pending",
                        ""
                      ],
                      [
                        "LogOff",
                        ""
                      ],
                      [
                        "UserProfileDiskMounted",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_fcd64ad557f04d4b85dfa42e5b169530": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_188abe107c7b4463a3b100f97e437196": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_244bbf1181834669bf15a07b45435295": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
userPrincipalName: string ,
applicationType: enum ,
sessionState: enum ,
activeDirectoryUserName: string ,
createTime: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
UserSessions_Get (updated)
Description Get a userSession.
Reference Link ¶

⚶ Changes

{
  "#id": "UserSessions_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "applicationType",
            "Enum": {
              "new": [
                [
                  "RemoteApp",
                  "Remote Applications (non-desktop)"
                ],
                [
                  "Desktop",
                  "Desktop Applications"
                ]
              ],
              "old": [
                [
                  "RemoteApp",
                  ""
                ],
                [
                  "Desktop",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "sessionState",
            "Enum": {
              "new": [
                [
                  "Unknown",
                  "SessionState is unknown"
                ],
                [
                  "Active",
                  "Session is active"
                ],
                [
                  "Disconnected",
                  "Session is disconnected"
                ],
                [
                  "Pending",
                  "Session is pending connection"
                ],
                [
                  "LogOff",
                  "Session is logging off"
                ],
                [
                  "UserProfileDiskMounted",
                  "Session has mounted user profile disk"
                ]
              ],
              "old": [
                [
                  "Unknown",
                  ""
                ],
                [
                  "Active",
                  ""
                ],
                [
                  "Disconnected",
                  ""
                ],
                [
                  "Pending",
                  ""
                ],
                [
                  "LogOff",
                  ""
                ],
                [
                  "UserProfileDiskMounted",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_c22a85d3f1f848438e997a1471e7c65d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_c9503019dcb84204a9568461ca14cef1": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_671120ebb1174ba5834091661b4c5263": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
userSessionId: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
userPrincipalName: string ,
applicationType: enum ,
sessionState: enum ,
activeDirectoryUserName: string ,
createTime: string ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
UserSessions_Delete (updated)
Description Remove a userSession.
Reference Link ¶

⚶ Changes

{
  "#id": "UserSessions_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_5f45033f57ea4467a3deb37543181f96": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_add041da12ff4ab9b88d9efccb5a14a6": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_b66f770b4dcf49aab14d38cd68313d88": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
userSessionId: string ,
force: boolean ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
UserSessions_Disconnect (updated)
Description Disconnect a userSession.
Reference Link ¶

⚶ Changes

{
  "#id": "UserSessions_Disconnect",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_2b3f330caef84a368079c4487a93b024": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_cbdd8b3fbdb4470ebe5aabf4b572c60f": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_93da058775f34fd780951d8c4f6515a6": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
userSessionId: string ,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
UserSessions_SendMessage (updated)
Description Send a message to a user.
Reference Link ¶

⚶ Changes

{
  "#id": "UserSessions_SendMessage",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_7f4de288ba3748b09d5fd27c281393e2": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_9badf973f178422ab8ef4998e6986ee4": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f97d0459a4044bd48d791e452ac82f03": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
sessionHostName: string ,
userSessionId: string ,
sendMessage:
{
messageTitle: string ,
messageBody: string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
UserSessions_ListByHostPool (updated)
Description A synchronous resource action.
Reference Link ¶

⚶ Changes

{
  "#id": "UserSessions_ListByHostPool",
  "Description": {
    "new": "A synchronous resource action.",
    "old": "List userSessions."
  },
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The UserSession items on this page",
            "old": "List of UserSession definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "applicationType",
                  "Enum": {
                    "new": [
                      [
                        "RemoteApp",
                        "Remote Applications (non-desktop)"
                      ],
                      [
                        "Desktop",
                        "Desktop Applications"
                      ]
                    ],
                    "old": [
                      [
                        "RemoteApp",
                        ""
                      ],
                      [
                        "Desktop",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "sessionState",
                  "Enum": {
                    "new": [
                      [
                        "Unknown",
                        "SessionState is unknown"
                      ],
                      [
                        "Active",
                        "Session is active"
                      ],
                      [
                        "Disconnected",
                        "Session is disconnected"
                      ],
                      [
                        "Pending",
                        "Session is pending connection"
                      ],
                      [
                        "LogOff",
                        "Session is logging off"
                      ],
                      [
                        "UserProfileDiskMounted",
                        "Session has mounted user profile disk"
                      ]
                    ],
                    "old": [
                      [
                        "Unknown",
                        ""
                      ],
                      [
                        "Active",
                        ""
                      ],
                      [
                        "Disconnected",
                        ""
                      ],
                      [
                        "Pending",
                        ""
                      ],
                      [
                        "LogOff",
                        ""
                      ],
                      [
                        "UserProfileDiskMounted",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_100fc90ae54e425c88c7e838e352cfd9": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_cf341b6a62394fd6bd7e3b34d584c326": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f29ef53640d241e1a178997ac29956f8": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
hostPoolName: string ,
$filter: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
userPrincipalName: string ,
applicationType: enum ,
sessionState: enum ,
activeDirectoryUserName: string ,
createTime: string ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_ListByResourceGroup (updated)
Description List scaling plans.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ScalingPlan items on this page",
            "old": "List of scaling plan definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "schedules",
                  "Description": {
                    "new": "List of ScalingPlanPooledSchedule definitions.",
                    "old": "List of Pooled ScalingSchedule definitions."
                  },
                  "$items": {
                    "$properties": [
                      {
                        "daysOfWeek": {
                          "Description": {
                            "new": "Day of the week. Modeled as string",
                            "old": "Day of the week."
                          },
                          "Enum": {
                            "new": [
                              [
                                "Monday",
                                ""
                              ],
                              [
                                "Tuesday",
                                ""
                              ],
                              [
                                "Wednesday",
                                ""
                              ],
                              [
                                "Thursday",
                                ""
                              ],
                              [
                                "Friday",
                                ""
                              ],
                              [
                                "Saturday",
                                ""
                              ],
                              [
                                "Sunday",
                                ""
                              ]
                            ],
                            "old": [
                              [
                                "Sunday",
                                ""
                              ],
                              [
                                "Monday",
                                ""
                              ],
                              [
                                "Tuesday",
                                ""
                              ],
                              [
                                "Wednesday",
                                ""
                              ],
                              [
                                "Thursday",
                                ""
                              ],
                              [
                                "Friday",
                                ""
                              ],
                              [
                                "Saturday",
                                ""
                              ]
                            ]
                          }
                        }
                      },
                      {
                        "#name": "rampUpLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "peakLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "rampDownLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "rampDownStopHostsWhen",
                        "Enum": {
                          "new": [
                            [
                              "ZeroSessions",
                              "Zero Total Sessions"
                            ],
                            [
                              "ZeroActiveSessions",
                              "Zero Active Sessions"
                            ]
                          ],
                          "old": [
                            [
                              "ZeroSessions",
                              ""
                            ],
                            [
                              "ZeroActiveSessions",
                              ""
                            ]
                          ]
                        }
                      },
                      {
                        "#name": "offPeakLoadBalancingAlgorithm",
                        "Enum": {
                          "new": [
                            [
                              "BreadthFirst",
                              "Breadth First Algorithm for Load Balancing"
                            ],
                            [
                              "DepthFirst",
                              "Depth First Algorithm for Load Balancing"
                            ]
                          ],
                          "old": [
                            [
                              "BreadthFirst",
                              ""
                            ],
                            [
                              "DepthFirst",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  }
                }
              ],
              "@added_15a3f5d166554af2bb8c16bbd80be310": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_e2ca9e8ca545471a92278c3787dbf61e": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_47f0ff82a4c4491198a3685d19396c55": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_44868c12405b4ebab0b98fcc07c99332": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_5277b308b0f447cfb67240d22309d121": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_b906b7822efc4ae5a752cb4fd9feb814": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_db06684e8a41457ea55f3d81f981df27": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_17bd5787ae614c13a38d42b5b3f4e57c": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_aa359d0b8457446e816915858df6e8e8": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_Get (updated)
Description Get a scaling plan.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "schedules",
            "Description": {
              "new": "List of ScalingPlanPooledSchedule definitions.",
              "old": "List of Pooled ScalingSchedule definitions."
            },
            "$items": {
              "$properties": [
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStopHostsWhen",
                  "Enum": {
                    "new": [
                      [
                        "ZeroSessions",
                        "Zero Total Sessions"
                      ],
                      [
                        "ZeroActiveSessions",
                        "Zero Active Sessions"
                      ]
                    ],
                    "old": [
                      [
                        "ZeroSessions",
                        ""
                      ],
                      [
                        "ZeroActiveSessions",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@added_f7ffc83996984b528b87c4b89cf66f53": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_4d5887d970fa4103ab1b623e7e8e0074": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_f497dae58bd84094a0930b541dd2b175": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_e1df615339da4042abfab174ead4f647": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_54647d7894a6442a9dae47c113364fa7": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_7f479271bcbd4a6c980f9304cc7c53ed": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f2d9eca9363342d7ad8f7a4f8c2e1155": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_6a6ce426dd934622950964fa832a8ff6": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_8eea9488e16c4ef08645669db63a5ee8": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_Create (updated)
Description Create or update a scaling plan.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_Create",
  "$parameters": {
    "scalingPlan": {
      "$properties": {
        "properties": [
          {
            "#name": "schedules",
            "Description": {
              "new": "List of ScalingPlanPooledSchedule definitions.",
              "old": "List of Pooled ScalingSchedule definitions."
            },
            "$items": {
              "$properties": [
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStopHostsWhen",
                  "Enum": {
                    "new": [
                      [
                        "ZeroSessions",
                        "Zero Total Sessions"
                      ],
                      [
                        "ZeroActiveSessions",
                        "Zero Active Sessions"
                      ]
                    ],
                    "old": [
                      [
                        "ZeroSessions",
                        ""
                      ],
                      [
                        "ZeroActiveSessions",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@added_7087b35f23f343be99fae5ab1464ca48": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_c3e200f025714e3c92e90143eee478d8": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_f44fc42aae0c4bedbdaf1d8ed772f2ae": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_f72c30b6d68d470f9c5439adbcc0cec0": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_05e2a371046645c396c53552c639caf1": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_f97cb1bab9254b4c85a72591e2ebb128": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "schedules",
            "Description": {
              "new": "List of ScalingPlanPooledSchedule definitions.",
              "old": "List of Pooled ScalingSchedule definitions."
            },
            "$items": {
              "$properties": [
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStopHostsWhen",
                  "Enum": {
                    "new": [
                      [
                        "ZeroSessions",
                        "Zero Total Sessions"
                      ],
                      [
                        "ZeroActiveSessions",
                        "Zero Active Sessions"
                      ]
                    ],
                    "old": [
                      [
                        "ZeroSessions",
                        ""
                      ],
                      [
                        "ZeroActiveSessions",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@added_be08bf9e9b7142369eda436e528db01a": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_cd92b9a3665b4f959120c56640d81625": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_585c7b84438647d4a98faf9ac70eba41": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_538142653c654784aa87f70557102038": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_1c2415e45c6f421eab84138701a4702c": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_1fb31ff2682740c1b77fd4189a526ecc": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "schedules",
            "Description": {
              "new": "List of ScalingPlanPooledSchedule definitions.",
              "old": "List of Pooled ScalingSchedule definitions."
            },
            "$items": {
              "$properties": [
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStopHostsWhen",
                  "Enum": {
                    "new": [
                      [
                        "ZeroSessions",
                        "Zero Total Sessions"
                      ],
                      [
                        "ZeroActiveSessions",
                        "Zero Active Sessions"
                      ]
                    ],
                    "old": [
                      [
                        "ZeroSessions",
                        ""
                      ],
                      [
                        "ZeroActiveSessions",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@added_18709bbe079447738df4d80dd7b5709f": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_ad68d58f25c94edbb30de8c5892ff8b7": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_198d28806f9c4a589607db1929f68bd0": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_7d3584d0f7d3480f94916b530c32ba2c": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_1310f9c00b114d778f5e7e26c961a657": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_2d79bad8555041c39e1a1b29a07d362a": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_e0fe1272fc074711851027038d3d9b07": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_1b6810f5bf2c4746a826682f457c777c": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_91520b75afe048d2ba7bc6389aa58ba2": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlan:
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_Update (updated)
Description Update a scaling plan.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_Update",
  "$parameters": [
    {
      "#name": "scalingPlan",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing scaling plan definitions."
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "schedules",
              "Description": {
                "new": "List of ScalingSchedule definitions.",
                "old": "List Pooled ScalingSchedule definitions."
              },
              "$items": {
                "$properties": [
                  {
                    "daysOfWeek": {
                      "Description": {
                        "new": "Day of the week. Modeled as string",
                        "old": "Day of the week."
                      },
                      "Enum": {
                        "new": [
                          [
                            "Monday",
                            ""
                          ],
                          [
                            "Tuesday",
                            ""
                          ],
                          [
                            "Wednesday",
                            ""
                          ],
                          [
                            "Thursday",
                            ""
                          ],
                          [
                            "Friday",
                            ""
                          ],
                          [
                            "Saturday",
                            ""
                          ],
                          [
                            "Sunday",
                            ""
                          ]
                        ],
                        "old": [
                          [
                            "Sunday",
                            ""
                          ],
                          [
                            "Monday",
                            ""
                          ],
                          [
                            "Tuesday",
                            ""
                          ],
                          [
                            "Wednesday",
                            ""
                          ],
                          [
                            "Thursday",
                            ""
                          ],
                          [
                            "Friday",
                            ""
                          ],
                          [
                            "Saturday",
                            ""
                          ]
                        ]
                      }
                    }
                  },
                  {
                    "#name": "rampUpLoadBalancingAlgorithm",
                    "Enum": {
                      "new": [
                        [
                          "BreadthFirst",
                          "Breadth First Algorithm for Load Balancing"
                        ],
                        [
                          "DepthFirst",
                          "Depth First Algorithm for Load Balancing"
                        ]
                      ],
                      "old": [
                        [
                          "BreadthFirst",
                          ""
                        ],
                        [
                          "DepthFirst",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "peakLoadBalancingAlgorithm",
                    "Enum": {
                      "new": [
                        [
                          "BreadthFirst",
                          "Breadth First Algorithm for Load Balancing"
                        ],
                        [
                          "DepthFirst",
                          "Depth First Algorithm for Load Balancing"
                        ]
                      ],
                      "old": [
                        [
                          "BreadthFirst",
                          ""
                        ],
                        [
                          "DepthFirst",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "rampDownLoadBalancingAlgorithm",
                    "Enum": {
                      "new": [
                        [
                          "BreadthFirst",
                          "Breadth First Algorithm for Load Balancing"
                        ],
                        [
                          "DepthFirst",
                          "Depth First Algorithm for Load Balancing"
                        ]
                      ],
                      "old": [
                        [
                          "BreadthFirst",
                          ""
                        ],
                        [
                          "DepthFirst",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "rampDownStopHostsWhen",
                    "Enum": {
                      "new": [
                        [
                          "ZeroSessions",
                          "Zero Total Sessions"
                        ],
                        [
                          "ZeroActiveSessions",
                          "Zero Active Sessions"
                        ]
                      ],
                      "old": [
                        [
                          "ZeroSessions",
                          ""
                        ],
                        [
                          "ZeroActiveSessions",
                          ""
                        ]
                      ]
                    }
                  },
                  {
                    "#name": "offPeakLoadBalancingAlgorithm",
                    "Enum": {
                      "new": [
                        [
                          "BreadthFirst",
                          "Breadth First Algorithm for Load Balancing"
                        ],
                        [
                          "DepthFirst",
                          "Depth First Algorithm for Load Balancing"
                        ]
                      ],
                      "old": [
                        [
                          "BreadthFirst",
                          ""
                        ],
                        [
                          "DepthFirst",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "schedules",
            "Description": {
              "new": "List of ScalingPlanPooledSchedule definitions.",
              "old": "List of Pooled ScalingSchedule definitions."
            },
            "$items": {
              "$properties": [
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStopHostsWhen",
                  "Enum": {
                    "new": [
                      [
                        "ZeroSessions",
                        "Zero Total Sessions"
                      ],
                      [
                        "ZeroActiveSessions",
                        "Zero Active Sessions"
                      ]
                    ],
                    "old": [
                      [
                        "ZeroSessions",
                        ""
                      ],
                      [
                        "ZeroActiveSessions",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        ],
        "@added_bb5bacec75ef4e66afdd36b50190f0b0": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_cfacc95d4f83463d8c45bdcd2225b7b5": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_2b837c0b971b4db1b55f6c30598c0fce": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_b4d1b1dc6c4c4430b00e028a87373f55": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_02162ee8d8c8491fb8980981ba65c00e": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_02eabe871ec24468a8389a9fe45f4224": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_99ac989f46a94155b859c12bbed50f47": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_21c31b42c76b4d77af0f95a9f4bc4ff7": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_c4a4713f53d147c7a8b31d3530adc013": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlan:
{
tags: object ,
properties:
{
description: string ,
friendlyName: string ,
timeZone: string ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
timeZone: string ,
hostPoolType: enum ,
exclusionTag: string ,
schedules:
[
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
]
,
hostPoolReferences:
[
{
hostPoolArmPath: string ,
scalingPlanEnabled: boolean ,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlans_Delete (updated)
Description Remove a scaling plan.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlans_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_74f014add9b54c9a95b24f8b801beff9": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_5c5e8b5ce2df489ba84c660589c0a41f": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_86fa15baafb0477c9d9003b3405c3c11": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ScalingPlanPersonalSchedule items on this page",
            "old": "List of ScalingPlanPersonalSchedule definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpStartVMOnConnect",
                  "Enum": {
                    "new": [
                      [
                        "Enable",
                        "Start VM on Connect is enabled"
                      ],
                      [
                        "Disable",
                        "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                      ]
                    ],
                    "old": [
                      [
                        "Enable",
                        ""
                      ],
                      [
                        "Disable",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampUpActionOnDisconnect",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampUpActionOnLogoff",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakStartVMOnConnect",
                  "Enum": {
                    "new": [
                      [
                        "Enable",
                        "Start VM on Connect is enabled"
                      ],
                      [
                        "Disable",
                        "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                      ]
                    ],
                    "old": [
                      [
                        "Enable",
                        ""
                      ],
                      [
                        "Disable",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakActionOnDisconnect",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakActionOnLogoff",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStartVMOnConnect",
                  "Enum": {
                    "new": [
                      [
                        "Enable",
                        "Start VM on Connect is enabled"
                      ],
                      [
                        "Disable",
                        "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                      ]
                    ],
                    "old": [
                      [
                        "Enable",
                        ""
                      ],
                      [
                        "Disable",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownActionOnDisconnect",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownActionOnLogoff",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakStartVMOnConnect",
                  "Enum": {
                    "new": [
                      [
                        "Enable",
                        "Start VM on Connect is enabled"
                      ],
                      [
                        "Disable",
                        "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                      ]
                    ],
                    "old": [
                      [
                        "Enable",
                        ""
                      ],
                      [
                        "Disable",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakActionOnDisconnect",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakActionOnLogoff",
                  "Enum": {
                    "new": [
                      [
                        "None",
                        "No action will be taken after disconnect"
                      ],
                      [
                        "Deallocate",
                        "Session Host will be deallocated after disconnect"
                      ],
                      [
                        "Hibernate",
                        "Session Host will hibernate after disconnect"
                      ]
                    ],
                    "old": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "Deallocate",
                        ""
                      ],
                      [
                        "Hibernate",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_5bafbdb245854a51b85c3ec9ffe0f233": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_49713547c360429fb9d5da85f53f4b8f": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_2a1e49cf62154ea58c3bedf2bf710aef": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_40d9735e0d984b31b40ef2e2c99cbc91": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_58bec9f6c94b4758b7597c57e137c211": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_167af98a35e245b394526d567fc656eb": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
}

⚐ Response (200)

{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlanPersonalSchedules_Create (updated)
Description Create or update a ScalingPlanPersonalSchedule.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Create",
  "$parameters": {
    "scalingPlanSchedule": {
      "$properties": {
        "properties": [
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_e0c9e41c55284a42be9416ae4ae3ebcf": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_5e78c3dfb16449878a59114fe637e274": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_aeeb8e072f724579b40a496f2ac41158": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
scalingPlanSchedule:
{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlanPersonalSchedules_Update (updated)
Description Update a ScalingPlanPersonalSchedule.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Update",
  "$parameters": [
    {
      "#name": "scalingPlanSchedule",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing ScalingPlanPersonalSchedule definitions."
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "daysOfWeek": {
                "Description": {
                  "new": "Day of the week. Modeled as string",
                  "old": "Day of the week."
                },
                "Enum": {
                  "new": [
                    [
                      "Monday",
                      ""
                    ],
                    [
                      "Tuesday",
                      ""
                    ],
                    [
                      "Wednesday",
                      ""
                    ],
                    [
                      "Thursday",
                      ""
                    ],
                    [
                      "Friday",
                      ""
                    ],
                    [
                      "Saturday",
                      ""
                    ],
                    [
                      "Sunday",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "Sunday",
                      ""
                    ],
                    [
                      "Monday",
                      ""
                    ],
                    [
                      "Tuesday",
                      ""
                    ],
                    [
                      "Wednesday",
                      ""
                    ],
                    [
                      "Thursday",
                      ""
                    ],
                    [
                      "Friday",
                      ""
                    ],
                    [
                      "Saturday",
                      ""
                    ]
                  ]
                }
              }
            },
            {
              "#name": "rampUpStartVMOnConnect",
              "Enum": {
                "new": [
                  [
                    "Enable",
                    "Start VM on Connect is enabled"
                  ],
                  [
                    "Disable",
                    "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                  ]
                ],
                "old": [
                  [
                    "Enable",
                    ""
                  ],
                  [
                    "Disable",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampUpActionOnDisconnect",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampUpActionOnLogoff",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "peakStartVMOnConnect",
              "Enum": {
                "new": [
                  [
                    "Enable",
                    "Start VM on Connect is enabled"
                  ],
                  [
                    "Disable",
                    "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                  ]
                ],
                "old": [
                  [
                    "Enable",
                    ""
                  ],
                  [
                    "Disable",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "peakActionOnDisconnect",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "peakActionOnLogoff",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampDownStartVMOnConnect",
              "Enum": {
                "new": [
                  [
                    "Enable",
                    "Start VM on Connect is enabled"
                  ],
                  [
                    "Disable",
                    "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                  ]
                ],
                "old": [
                  [
                    "Enable",
                    ""
                  ],
                  [
                    "Disable",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampDownActionOnDisconnect",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampDownActionOnLogoff",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "offPeakStartVMOnConnect",
              "Enum": {
                "new": [
                  [
                    "Enable",
                    "Start VM on Connect is enabled"
                  ],
                  [
                    "Disable",
                    "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                  ]
                ],
                "old": [
                  [
                    "Enable",
                    ""
                  ],
                  [
                    "Disable",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "offPeakActionOnDisconnect",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "offPeakActionOnLogoff",
              "Enum": {
                "new": [
                  [
                    "None",
                    "No action will be taken after disconnect"
                  ],
                  [
                    "Deallocate",
                    "Session Host will be deallocated after disconnect"
                  ],
                  [
                    "Hibernate",
                    "Session Host will hibernate after disconnect"
                  ]
                ],
                "old": [
                  [
                    "None",
                    ""
                  ],
                  [
                    "Deallocate",
                    ""
                  ],
                  [
                    "Hibernate",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampUpActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakStartVMOnConnect",
            "Enum": {
              "new": [
                [
                  "Enable",
                  "Start VM on Connect is enabled"
                ],
                [
                  "Disable",
                  "Start VM on Connect is disabled, must use rampUpAutoStartHosts or turn on manually"
                ]
              ],
              "old": [
                [
                  "Enable",
                  ""
                ],
                [
                  "Disable",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnDisconnect",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakActionOnLogoff",
            "Enum": {
              "new": [
                [
                  "None",
                  "No action will be taken after disconnect"
                ],
                [
                  "Deallocate",
                  "Session Host will be deallocated after disconnect"
                ],
                [
                  "Hibernate",
                  "Session Host will hibernate after disconnect"
                ]
              ],
              "old": [
                [
                  "None",
                  ""
                ],
                [
                  "Deallocate",
                  ""
                ],
                [
                  "Hibernate",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_99a824ba46ed4c16936ece47e018aea9": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_d9ae8be70e624f069a9e73d135c28994": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_cd3bb3600c0e46eca1bcfac91d459bc9": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
scalingPlanSchedule:
{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpAutoStartHosts: enum ,
rampUpStartVMOnConnect: enum ,
rampUpActionOnDisconnect: enum ,
rampUpMinutesToWaitOnDisconnect: integer ,
rampUpActionOnLogoff: enum ,
rampUpMinutesToWaitOnLogoff: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakStartVMOnConnect: enum ,
peakActionOnDisconnect: enum ,
peakMinutesToWaitOnDisconnect: integer ,
peakActionOnLogoff: enum ,
peakMinutesToWaitOnLogoff: integer ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownStartVMOnConnect: enum ,
rampDownActionOnDisconnect: enum ,
rampDownMinutesToWaitOnDisconnect: integer ,
rampDownActionOnLogoff: enum ,
rampDownMinutesToWaitOnLogoff: integer ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakStartVMOnConnect: enum ,
offPeakActionOnDisconnect: enum ,
offPeakMinutesToWaitOnDisconnect: integer ,
offPeakActionOnLogoff: enum ,
offPeakMinutesToWaitOnLogoff: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlanPersonalSchedules_Delete (updated)
Description Remove a ScalingPlanPersonalSchedule.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPersonalSchedules_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_b1f97193f52743df922a0f2355938e3d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_7720b52ae1f8466f84177f388f69a60d": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_294954c1259241f689e4caf61498979c": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/personalSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlanPooledSchedules_List (updated)
Description List ScalingPlanPooledSchedules.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_List",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The ScalingPlanPooledSchedule items on this page",
            "old": "List of ScalingPlanPooledSchedule definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "name",
                  "Description": {
                    "new": "Name of the ScalingPlanPooledSchedule",
                    "old": "Name of the ScalingPlanPooledSchedule."
                  }
                },
                {
                  "daysOfWeek": {
                    "Description": {
                      "new": "Day of the week. Modeled as string",
                      "old": "Day of the week."
                    },
                    "Enum": {
                      "new": [
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ],
                        [
                          "Sunday",
                          ""
                        ]
                      ],
                      "old": [
                        [
                          "Sunday",
                          ""
                        ],
                        [
                          "Monday",
                          ""
                        ],
                        [
                          "Tuesday",
                          ""
                        ],
                        [
                          "Wednesday",
                          ""
                        ],
                        [
                          "Thursday",
                          ""
                        ],
                        [
                          "Friday",
                          ""
                        ],
                        [
                          "Saturday",
                          ""
                        ]
                      ]
                    }
                  }
                },
                {
                  "#name": "rampUpLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "peakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "rampDownStopHostsWhen",
                  "Enum": {
                    "new": [
                      [
                        "ZeroSessions",
                        "Zero Total Sessions"
                      ],
                      [
                        "ZeroActiveSessions",
                        "Zero Active Sessions"
                      ]
                    ],
                    "old": [
                      [
                        "ZeroSessions",
                        ""
                      ],
                      [
                        "ZeroActiveSessions",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "#name": "offPeakLoadBalancingAlgorithm",
                  "Enum": {
                    "new": [
                      [
                        "BreadthFirst",
                        "Breadth First Algorithm for Load Balancing"
                      ],
                      [
                        "DepthFirst",
                        "Depth First Algorithm for Load Balancing"
                      ]
                    ],
                    "old": [
                      [
                        "BreadthFirst",
                        ""
                      ],
                      [
                        "DepthFirst",
                        ""
                      ]
                    ]
                  }
                }
              ]
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_71e0cd9dee7240fe983fd3f941188d57": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b62dacb1f01a4711a8435f20219ed738": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_e2095da7c2ff4f2a8d196d07f5c9b812": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the ScalingPlanPooledSchedule",
              "old": "Name of the ScalingPlanPooledSchedule."
            }
          },
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStopHostsWhen",
            "Enum": {
              "new": [
                [
                  "ZeroSessions",
                  "Zero Total Sessions"
                ],
                [
                  "ZeroActiveSessions",
                  "Zero Active Sessions"
                ]
              ],
              "old": [
                [
                  "ZeroSessions",
                  ""
                ],
                [
                  "ZeroActiveSessions",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_c0a120130a904d26a7db668e854dca72": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_e529f900aff844e4a7a31157587e754f": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_a7b64fbf42bb47ee8a128e1370a39b70": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
}

⚐ Response (200)

{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Create",
  "$parameters": {
    "scalingPlanSchedule": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the ScalingPlanPooledSchedule",
              "old": "Name of the ScalingPlanPooledSchedule."
            }
          },
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStopHostsWhen",
            "Enum": {
              "new": [
                [
                  "ZeroSessions",
                  "Zero Total Sessions"
                ],
                [
                  "ZeroActiveSessions",
                  "Zero Active Sessions"
                ]
              ],
              "old": [
                [
                  "ZeroSessions",
                  ""
                ],
                [
                  "ZeroActiveSessions",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          }
        ]
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the ScalingPlanPooledSchedule",
              "old": "Name of the ScalingPlanPooledSchedule."
            }
          },
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStopHostsWhen",
            "Enum": {
              "new": [
                [
                  "ZeroSessions",
                  "Zero Total Sessions"
                ],
                [
                  "ZeroActiveSessions",
                  "Zero Active Sessions"
                ]
              ],
              "old": [
                [
                  "ZeroSessions",
                  ""
                ],
                [
                  "ZeroActiveSessions",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the ScalingPlanPooledSchedule",
              "old": "Name of the ScalingPlanPooledSchedule."
            }
          },
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStopHostsWhen",
            "Enum": {
              "new": [
                [
                  "ZeroSessions",
                  "Zero Total Sessions"
                ],
                [
                  "ZeroActiveSessions",
                  "Zero Active Sessions"
                ]
              ],
              "old": [
                [
                  "ZeroSessions",
                  ""
                ],
                [
                  "ZeroActiveSessions",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_4396a439c0be491eae4280a8f6c11152": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_990198dcc3f04f39bc23a5b29f62020c": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_c231e27d3a4d4c7cb5e78193e5699449": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
scalingPlanSchedule:
{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}

⚐ Response (201)

{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}

⚐ Response (default)

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

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Update",
  "$parameters": [
    {
      "#name": "scalingPlanSchedule",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing ScalingPlanPooledSchedule definitions."
      },
      "$schema": {
        "$properties": {
          "properties": [
            {
              "#name": "name",
              "Description": {
                "new": "Name of the ScalingPlanPooledSchedule",
                "old": "Name of the ScalingPlanPooledSchedule."
              }
            },
            {
              "daysOfWeek": {
                "Description": {
                  "new": "Day of the week. Modeled as string",
                  "old": "Day of the week."
                },
                "Enum": {
                  "new": [
                    [
                      "Monday",
                      ""
                    ],
                    [
                      "Tuesday",
                      ""
                    ],
                    [
                      "Wednesday",
                      ""
                    ],
                    [
                      "Thursday",
                      ""
                    ],
                    [
                      "Friday",
                      ""
                    ],
                    [
                      "Saturday",
                      ""
                    ],
                    [
                      "Sunday",
                      ""
                    ]
                  ],
                  "old": [
                    [
                      "Sunday",
                      ""
                    ],
                    [
                      "Monday",
                      ""
                    ],
                    [
                      "Tuesday",
                      ""
                    ],
                    [
                      "Wednesday",
                      ""
                    ],
                    [
                      "Thursday",
                      ""
                    ],
                    [
                      "Friday",
                      ""
                    ],
                    [
                      "Saturday",
                      ""
                    ]
                  ]
                }
              }
            },
            {
              "#name": "rampUpLoadBalancingAlgorithm",
              "Enum": {
                "new": [
                  [
                    "BreadthFirst",
                    "Breadth First Algorithm for Load Balancing"
                  ],
                  [
                    "DepthFirst",
                    "Depth First Algorithm for Load Balancing"
                  ]
                ],
                "old": [
                  [
                    "BreadthFirst",
                    ""
                  ],
                  [
                    "DepthFirst",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "peakLoadBalancingAlgorithm",
              "Enum": {
                "new": [
                  [
                    "BreadthFirst",
                    "Breadth First Algorithm for Load Balancing"
                  ],
                  [
                    "DepthFirst",
                    "Depth First Algorithm for Load Balancing"
                  ]
                ],
                "old": [
                  [
                    "BreadthFirst",
                    ""
                  ],
                  [
                    "DepthFirst",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampDownLoadBalancingAlgorithm",
              "Enum": {
                "new": [
                  [
                    "BreadthFirst",
                    "Breadth First Algorithm for Load Balancing"
                  ],
                  [
                    "DepthFirst",
                    "Depth First Algorithm for Load Balancing"
                  ]
                ],
                "old": [
                  [
                    "BreadthFirst",
                    ""
                  ],
                  [
                    "DepthFirst",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "rampDownStopHostsWhen",
              "Enum": {
                "new": [
                  [
                    "ZeroSessions",
                    "Zero Total Sessions"
                  ],
                  [
                    "ZeroActiveSessions",
                    "Zero Active Sessions"
                  ]
                ],
                "old": [
                  [
                    "ZeroSessions",
                    ""
                  ],
                  [
                    "ZeroActiveSessions",
                    ""
                  ]
                ]
              }
            },
            {
              "#name": "offPeakLoadBalancingAlgorithm",
              "Enum": {
                "new": [
                  [
                    "BreadthFirst",
                    "Breadth First Algorithm for Load Balancing"
                  ],
                  [
                    "DepthFirst",
                    "Depth First Algorithm for Load Balancing"
                  ]
                ],
                "old": [
                  [
                    "BreadthFirst",
                    ""
                  ],
                  [
                    "DepthFirst",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "name",
            "Description": {
              "new": "Name of the ScalingPlanPooledSchedule",
              "old": "Name of the ScalingPlanPooledSchedule."
            }
          },
          {
            "daysOfWeek": {
              "Description": {
                "new": "Day of the week. Modeled as string",
                "old": "Day of the week."
              },
              "Enum": {
                "new": [
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ],
                  [
                    "Sunday",
                    ""
                  ]
                ],
                "old": [
                  [
                    "Sunday",
                    ""
                  ],
                  [
                    "Monday",
                    ""
                  ],
                  [
                    "Tuesday",
                    ""
                  ],
                  [
                    "Wednesday",
                    ""
                  ],
                  [
                    "Thursday",
                    ""
                  ],
                  [
                    "Friday",
                    ""
                  ],
                  [
                    "Saturday",
                    ""
                  ]
                ]
              }
            }
          },
          {
            "#name": "rampUpLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "peakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "rampDownStopHostsWhen",
            "Enum": {
              "new": [
                [
                  "ZeroSessions",
                  "Zero Total Sessions"
                ],
                [
                  "ZeroActiveSessions",
                  "Zero Active Sessions"
                ]
              ],
              "old": [
                [
                  "ZeroSessions",
                  ""
                ],
                [
                  "ZeroActiveSessions",
                  ""
                ]
              ]
            }
          },
          {
            "#name": "offPeakLoadBalancingAlgorithm",
            "Enum": {
              "new": [
                [
                  "BreadthFirst",
                  "Breadth First Algorithm for Load Balancing"
                ],
                [
                  "DepthFirst",
                  "Depth First Algorithm for Load Balancing"
                ]
              ],
              "old": [
                [
                  "BreadthFirst",
                  ""
                ],
                [
                  "DepthFirst",
                  ""
                ]
              ]
            }
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_90f6416eb2e3411eb80e6f5fbb24baa0": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_7b6ed5652f2449e9b8304ed03f907776": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_ee29ccfd77fe4951ad8436c9a48691bf": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
scalingPlanSchedule:
{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
name: string ,
daysOfWeek:
[
string ,
]
,
rampUpStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampUpLoadBalancingAlgorithm: enum ,
rampUpMinimumHostsPct: integer ,
rampUpCapacityThresholdPct: integer ,
peakStartTime:
{
hour: integer ,
minute: integer ,
}
,
peakLoadBalancingAlgorithm: enum ,
rampDownStartTime:
{
hour: integer ,
minute: integer ,
}
,
rampDownLoadBalancingAlgorithm: enum ,
rampDownMinimumHostsPct: integer ,
rampDownCapacityThresholdPct: integer ,
rampDownForceLogoffUsers: boolean ,
rampDownStopHostsWhen: enum ,
rampDownWaitTimeMinutes: integer ,
rampDownNotificationMessage: string ,
offPeakStartTime:
{
hour: integer ,
minute: integer ,
}
,
offPeakLoadBalancingAlgorithm: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
ScalingPlanPooledSchedules_Delete (updated)
Description Remove a ScalingPlanPooledSchedule.
Reference Link ¶

⚶ Changes

{
  "#id": "ScalingPlanPooledSchedules_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f071ae889dbe41ea97f60207de31be2d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_36315d64b17040198f4e6c1c8c779469": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_8ac72d02e1d446f2a66e9e8b56127a02": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/scalingPlans/{scalingPlanName}/pooledSchedules/{scalingPlanScheduleName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
scalingPlanName: string ,
scalingPlanScheduleName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Workspaces_ListByResourceGroup (updated)
Description List workspaces.
Reference Link ¶

⚶ Changes

{
  "#id": "Workspaces_ListByResourceGroup",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The Workspace items on this page",
            "old": "List of Workspace definitions."
          },
          "Required": {
            "new": true,
            "old": false
          },
          "$items": {
            "$properties": {
              "properties": [
                {
                  "#name": "publicNetworkAccess",
                  "Enum": {
                    "new": [
                      [
                        "Enabled",
                        "This resource is accessible from the public network."
                      ],
                      [
                        "Disabled",
                        "This resource is not accessible from the public network."
                      ]
                    ],
                    "old": [
                      [
                        "Enabled",
                        ""
                      ],
                      [
                        "Disabled",
                        ""
                      ]
                    ]
                  }
                },
                {
                  "privateEndpointConnections": {
                    "$properties": {
                      "properties": [
                        {
                          "privateLinkServiceConnectionState": [
                            {
                              "#name": "status",
                              "Enum": {
                                "new": [
                                  [
                                    "Pending",
                                    "Connection is Pending"
                                  ],
                                  [
                                    "Approved",
                                    "Connection was Approved"
                                  ],
                                  [
                                    "Rejected",
                                    "Connection was rejected"
                                  ]
                                ],
                                "old": [
                                  [
                                    "Pending",
                                    ""
                                  ],
                                  [
                                    "Approved",
                                    ""
                                  ],
                                  [
                                    "Rejected",
                                    ""
                                  ]
                                ]
                              }
                            }
                          ]
                        },
                        {
                          "#name": "provisioningState",
                          "Enum": {
                            "new": [
                              [
                                "Succeeded",
                                "Provisioning was successful"
                              ],
                              [
                                "Creating",
                                "A PrivateEndpointConnection is being created"
                              ],
                              [
                                "Deleting",
                                "A PrivateEndpointConnection is being deleted"
                              ],
                              [
                                "Failed",
                                "Provisioning failed"
                              ]
                            ],
                            "old": [
                              [
                                "Succeeded",
                                ""
                              ],
                              [
                                "Creating",
                                ""
                              ],
                              [
                                "Deleting",
                                ""
                              ],
                              [
                                "Failed",
                                ""
                              ]
                            ]
                          }
                        }
                      ]
                    }
                  }
                }
              ],
              "@added_8d3efec51b2148f59d4d0f3176914151": {
                "#name": "identity",
                "Description": "The managed service identities assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "principalId",
                    "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "tenantId",
                    "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
                    "Format": "uuid",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "type",
                    "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
                    "Enum": [
                      [
                        "None",
                        ""
                      ],
                      [
                        "SystemAssigned",
                        ""
                      ],
                      [
                        "UserAssigned",
                        ""
                      ],
                      [
                        "SystemAssigned,UserAssigned",
                        ""
                      ]
                    ],
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "userAssignedIdentities",
                    "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
                    "Required": false,
                    "Type": "object"
                  }
                ]
              },
              "@added_febcd9840202471688a24096534d1a5c": {
                "#name": "etag",
                "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
                "Required": false,
                "Type": "string"
              },
              "@added_bb5dd675c4964eedb32d6860129de12d": {
                "#name": "kind",
                "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
                "Required": false,
                "Type": "string"
              },
              "@added_8884c00ac29b4dbe9a479d93da3b0379": {
                "#name": "managedBy",
                "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
                "Required": false,
                "Type": "string"
              },
              "@added_968ef181176743c388a47df6976960be": {
                "#name": "plan",
                "Description": "Details of the resource plan.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "publisher",
                    "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "product",
                    "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "promotionCode",
                    "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "version",
                    "Description": "The version of the desired product/artifact.",
                    "Required": false,
                    "Type": "string"
                  }
                ]
              },
              "@added_46616de40ca34434b3ad1245f1578aa9": {
                "#name": "sku",
                "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
                "Required": false,
                "Type": "object",
                "$properties": [
                  {
                    "#name": "name",
                    "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
                    "Required": true,
                    "Type": "string"
                  },
                  {
                    "#name": "tier",
                    "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
                    "Enum": [
                      [
                        "Free",
                        ""
                      ],
                      [
                        "Basic",
                        ""
                      ],
                      [
                        "Standard",
                        ""
                      ],
                      [
                        "Premium",
                        ""
                      ]
                    ],
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "size",
                    "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "family",
                    "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
                    "Required": false,
                    "Type": "string"
                  },
                  {
                    "#name": "capacity",
                    "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
                    "Format": "int32",
                    "Required": false,
                    "Type": "integer"
                  }
                ]
              }
            }
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_b060296f8cb24f818b07e9e58851515b": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_b03b5e54ef4b417d967c42d05299ee45": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_95ed3daf75134b36856b7fc554e7203f": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Workspaces_Get (updated)
Description Get a workspace.
Reference Link ¶

⚶ Changes

{
  "#id": "Workspaces_Get",
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "This resource is accessible from the public network."
                ],
                [
                  "Disabled",
                  "This resource is not accessible from the public network."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        ],
        "@added_5485711e551e45e89093edc4d0e75de9": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_573cc66cc9134c6cbaad9ec3dd83ca90": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_c1e2d2b1e26c4fcfbd16109e7d2c2ee3": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_937689e5a1274836a73091d40204e5db": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_60ea89ce63d94970a3f353083c2a798f": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_7e02ab98cc0a475690e96fa7a3288aa1": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_bb59667d066a427eaf3b4063d73a44a7": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_a8178f5cb5b441e5a2e4a9a162098023": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_f45b18270ea647399da3d5ae9e8ea49a": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Workspaces_CreateOrUpdate (updated)
Description Create or update a workspace.
Reference Link ¶

⚶ Changes

{
  "#id": "Workspaces_CreateOrUpdate",
  "$parameters": {
    "workspace": {
      "$properties": {
        "properties": [
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "This resource is accessible from the public network."
                ],
                [
                  "Disabled",
                  "This resource is not accessible from the public network."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        ],
        "@added_4e1afc7813f14f13872903e577ccc824": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_ebbaa367ba0f4fe392db04edb66fbe8c": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_da35100548b9468d8bcc18061dd8cf90": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_7ec9c9540fca4118a2581e5658d8553b": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_eea3cd4a442044ac9c1531376fdfbc89": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_db14cd8bd9e441ce99e13352909040d8": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    }
  },
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "This resource is accessible from the public network."
                ],
                [
                  "Disabled",
                  "This resource is not accessible from the public network."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        ],
        "@added_4376f2de9e554694bcf87b2c2320677f": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_eaf3920a26c041569e92d1254212495f": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_53edda556958494d9fcfe5517a137549": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_1f43c7e5ac0443e7acdbabf889da7c04": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_aae986e0473e4c98a9593434b4c2b786": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_6ea09ef4868d4edaab34584c7490bcfb": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "201": {
      "$properties": {
        "properties": [
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "This resource is accessible from the public network."
                ],
                [
                  "Disabled",
                  "This resource is not accessible from the public network."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        ],
        "@added_a9e9f06f86f04361a11040223dfae6e5": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_08079cc86b414b76873ff00c8b7eb492": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_efd13baddc984114a7f1c96116c0f9b3": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_d192a4d651b54b9c886791c3ba8bd34f": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_2f2b874fb31848fe8fe366839f8995ad": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_21c0c772b41048839517742c2dde3fb3": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_5d9e1b0b72c0403c93cb35bac5a9e74d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_aa78cb4a7f1a447981ffaf8fb58146bc": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_1ba98d540a6f4197bbdc9aad174767f4": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
workspace:
{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (201)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Workspaces_Update (updated)
Description Update a workspace.
Reference Link ¶

⚶ Changes

{
  "#id": "Workspaces_Update",
  "$parameters": [
    {
      "#name": "workspace",
      "Description": {
        "new": "The resource properties to be updated",
        "old": "Object containing Workspace definitions."
      },
      "$schema": {
        "Description": {
          "new": "Workspace properties that can be patched.A patch model",
          "old": "Workspace properties that can be patched."
        },
        "$properties": {
          "properties": [
            {
              "#name": "publicNetworkAccess",
              "Enum": {
                "new": [
                  [
                    "Enabled",
                    "This resource is accessible from the public network."
                  ],
                  [
                    "Disabled",
                    "This resource is not accessible from the public network."
                  ]
                ],
                "old": [
                  [
                    "Enabled",
                    ""
                  ],
                  [
                    "Disabled",
                    ""
                  ]
                ]
              }
            }
          ]
        }
      }
    }
  ],
  "$responses": {
    "200": {
      "$properties": {
        "properties": [
          {
            "#name": "publicNetworkAccess",
            "Enum": {
              "new": [
                [
                  "Enabled",
                  "This resource is accessible from the public network."
                ],
                [
                  "Disabled",
                  "This resource is not accessible from the public network."
                ]
              ],
              "old": [
                [
                  "Enabled",
                  ""
                ],
                [
                  "Disabled",
                  ""
                ]
              ]
            }
          },
          {
            "privateEndpointConnections": {
              "$properties": {
                "properties": [
                  {
                    "privateLinkServiceConnectionState": [
                      {
                        "#name": "status",
                        "Enum": {
                          "new": [
                            [
                              "Pending",
                              "Connection is Pending"
                            ],
                            [
                              "Approved",
                              "Connection was Approved"
                            ],
                            [
                              "Rejected",
                              "Connection was rejected"
                            ]
                          ],
                          "old": [
                            [
                              "Pending",
                              ""
                            ],
                            [
                              "Approved",
                              ""
                            ],
                            [
                              "Rejected",
                              ""
                            ]
                          ]
                        }
                      }
                    ]
                  },
                  {
                    "#name": "provisioningState",
                    "Enum": {
                      "new": [
                        [
                          "Succeeded",
                          "Provisioning was successful"
                        ],
                        [
                          "Creating",
                          "A PrivateEndpointConnection is being created"
                        ],
                        [
                          "Deleting",
                          "A PrivateEndpointConnection is being deleted"
                        ],
                        [
                          "Failed",
                          "Provisioning failed"
                        ]
                      ],
                      "old": [
                        [
                          "Succeeded",
                          ""
                        ],
                        [
                          "Creating",
                          ""
                        ],
                        [
                          "Deleting",
                          ""
                        ],
                        [
                          "Failed",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              }
            }
          }
        ],
        "@added_a6b93f641b774cb8881b5d98fe6ec7b6": {
          "#name": "identity",
          "Description": "The managed service identities assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "principalId",
              "Description": "The service principal ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "tenantId",
              "Description": "The tenant ID of the system assigned identity. This property will only be provided for a system assigned identity.",
              "Format": "uuid",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "type",
              "Description": "Type of managed service identity (where both SystemAssigned and UserAssigned types are allowed).",
              "Enum": [
                [
                  "None",
                  ""
                ],
                [
                  "SystemAssigned",
                  ""
                ],
                [
                  "UserAssigned",
                  ""
                ],
                [
                  "SystemAssigned,UserAssigned",
                  ""
                ]
              ],
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "userAssignedIdentities",
              "Description": "The set of user assigned identities associated with the resource. The userAssignedIdentities dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. The dictionary values can be empty objects ({}) in requests.",
              "Required": false,
              "Type": "object"
            }
          ]
        },
        "@added_709f76c5ac3e48ea9085700253738b74": {
          "#name": "etag",
          "Description": "If etag is provided in the response body, it may also be provided as a header per the normal etag convention.  Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.",
          "Required": false,
          "Type": "string"
        },
        "@added_47deeded8a7a4b689eb7ee77d08b159a": {
          "#name": "kind",
          "Description": "Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type.  If supported, the resource provider must validate and persist this value.",
          "Required": false,
          "Type": "string"
        },
        "@added_693981db15594f65ac26ee292983e5ae": {
          "#name": "managedBy",
          "Description": "The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.",
          "Required": false,
          "Type": "string"
        },
        "@added_5055d07fbf3943eba236c67c88afdcee": {
          "#name": "plan",
          "Description": "Details of the resource plan.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "A user defined name of the 3rd Party Artifact that is being procured.",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "publisher",
              "Description": "The publisher of the 3rd Party Artifact that is being bought. E.g. NewRelic",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "product",
              "Description": "The 3rd Party artifact that is being procured. E.g. NewRelic. Product maps to the OfferID specified for the artifact at the time of Data Market onboarding. ",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "promotionCode",
              "Description": "A publisher provided promotion code as provisioned in Data Market for the said product/artifact.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "version",
              "Description": "The version of the desired product/artifact.",
              "Required": false,
              "Type": "string"
            }
          ]
        },
        "@added_a6dd805f2ab148a4b66a180c964b8037": {
          "#name": "sku",
          "Description": "The SKU (Stock Keeping Unit) assigned to this resource.",
          "Required": false,
          "Type": "object",
          "$properties": [
            {
              "#name": "name",
              "Description": "The name of the SKU. E.g. P3. It is typically a letter+number code",
              "Required": true,
              "Type": "string"
            },
            {
              "#name": "tier",
              "Description": "This field is required to be implemented by the Resource Provider if the service has more than one tier, but is not required on a PUT.",
              "Enum": [
                [
                  "Free",
                  ""
                ],
                [
                  "Basic",
                  ""
                ],
                [
                  "Standard",
                  ""
                ],
                [
                  "Premium",
                  ""
                ]
              ],
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "size",
              "Description": "The SKU size. When the name field is the combination of tier and some other value, this would be the standalone code. ",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "family",
              "Description": "If the service has different generations of hardware, for the same SKU, then that can be captured here.",
              "Required": false,
              "Type": "string"
            },
            {
              "#name": "capacity",
              "Description": "If the SKU supports scale out/in then the capacity integer should be included. If scale out/in is not possible for the resource this may be omitted.",
              "Format": "int32",
              "Required": false,
              "Type": "integer"
            }
          ]
        }
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_74a91431567c455a8e77678698f4b9f1": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_574dee9a7e4940b9bcca20a3be6555f3": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_54ba76872c1d4dcfb147eeb1547a47f5": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
workspace:
{
tags: object ,
properties:
{
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
publicNetworkAccess: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
objectId: string ,
description: string ,
friendlyName: string ,
applicationGroupReferences:
[
string ,
]
,
cloudPcResource: boolean ,
publicNetworkAccess: enum ,
privateEndpointConnections:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
}
,
identity:
{
principalId: string ,
tenantId: string ,
type: enum ,
userAssignedIdentities: object ,
}
,
etag: string ,
kind: string ,
managedBy: string ,
plan:
{
name: string ,
publisher: string ,
product: string ,
promotionCode: string ,
version: string ,
}
,
sku:
{
name: string ,
tier: enum ,
size: string ,
family: string ,
capacity: integer ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
Workspaces_Delete (updated)
Description Remove a workspace.
Reference Link ¶

⚶ Changes

{
  "#id": "Workspaces_Delete",
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_ca6fd0bf60874ea38f23c01456d0bf0b": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_ae15c4c685864cedaf1c966ecd3d034d": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_5e9a2d7ad7114c429f986404c1538387": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_ListByWorkspace (updated)
Description Get a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_ListByWorkspace",
  "Description": {
    "new": "Get a PrivateEndpointConnectionWithSystemData",
    "old": "List private endpoint connections."
  },
  "$responses": {
    "200": {
      "Description": {
        "new": "List of private endpoint connection associated with the specified HostPool",
        "old": "List of private endpoint connection associated with the specified storage account"
      },
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateEndpointConnectionWithSystemData items on this page",
            "old": "Array of private endpoint connections"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_8126f693196c4a6388147595f7a5b122": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_84a7cd11038341d590d46fc68d3bb866": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_9a6f0593ade24d2682b63595e124a2d3": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_GetByWorkspace (updated)
Description Get a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_GetByWorkspace",
  "Description": {
    "new": "Get a PrivateEndpointConnectionWithSystemData",
    "old": "Get a private endpoint connection."
  },
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name parameter for private endpoint",
        "old": "The name of the private endpoint connection associated with the Azure resource."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_6d4b62a340d94b259a40d7c73b05420a": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_3705188142e54f758cf6341c094e9bc8": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_ec2904401c494d9e9c97866f86f63391": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_UpdateByWorkspace (updated)
Description Create a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_UpdateByWorkspace",
  "Description": {
    "new": "Create a PrivateEndpointConnectionWithSystemData",
    "old": "Approve or reject a private endpoint connection."
  },
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name parameter for private endpoint",
        "old": "The name of the private endpoint connection associated with the Azure resource."
      }
    },
    {
      "#name": "connection",
      "Description": {
        "new": "Resource create parameters.",
        "old": "Object containing the updated connection."
      },
      "$schema": {
        "Description": {
          "new": "The Private Endpoint Connection resource.",
          "old": "The private endpoint connection resource."
        },
        "$properties": [
          {
            "#name": "properties",
            "Description": {
              "new": "The resource-specific properties for this resource.",
              "old": "Resource properties."
            },
            "$properties": [
              {
                "privateLinkServiceConnectionState": [
                  {
                    "#name": "status",
                    "Enum": {
                      "new": [
                        [
                          "Pending",
                          "Connection is Pending"
                        ],
                        [
                          "Approved",
                          "Connection was Approved"
                        ],
                        [
                          "Rejected",
                          "Connection was rejected"
                        ]
                      ],
                      "old": [
                        [
                          "Pending",
                          ""
                        ],
                        [
                          "Approved",
                          ""
                        ],
                        [
                          "Rejected",
                          ""
                        ]
                      ]
                    }
                  }
                ]
              },
              {
                "#name": "provisioningState",
                "Enum": {
                  "new": [
                    [
                      "Succeeded",
                      "Provisioning was successful"
                    ],
                    [
                      "Creating",
                      "A PrivateEndpointConnection is being created"
                    ],
                    [
                      "Deleting",
                      "A PrivateEndpointConnection is being deleted"
                    ],
                    [
                      "Failed",
                      "Provisioning failed"
                    ]
                  ],
                  "old": [
                    [
                      "Succeeded",
                      ""
                    ],
                    [
                      "Creating",
                      ""
                    ],
                    [
                      "Deleting",
                      ""
                    ],
                    [
                      "Failed",
                      ""
                    ]
                  ]
                }
              }
            ]
          }
        ]
      }
    }
  ],
  "$responses": {
    "@added_13423d0077bf415d88323ce28fcb5751": {
      "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"
              }
            ]
          }
        ]
      }
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_f8070ed3fd1f4fbb994ad91a6d33646e": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_54d3998ebe0e4dc5913a747ae7804ce7": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_0d945bbef75e481384aa3328d56bb7ec": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
privateEndpointConnectionName: string ,
connection:
{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}
,
}

⚐ Response (200)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (201)

{
properties:
{
groupIds:
[
string ,
]
,
privateEndpoint:
{
id: string ,
}
,
privateLinkServiceConnectionState:
{
status: enum ,
description: string ,
actionsRequired: string ,
}
,
provisioningState: enum ,
}
,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateEndpointConnections_DeleteByWorkspace (updated)
Description Delete a PrivateEndpointConnectionWithSystemData
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateEndpointConnections_DeleteByWorkspace",
  "Description": {
    "new": "Delete a PrivateEndpointConnectionWithSystemData",
    "old": "Remove a connection."
  },
  "$parameters": [
    {
      "#name": "privateEndpointConnectionName",
      "Description": {
        "new": "The name parameter for private endpoint",
        "old": "The name of the private endpoint connection associated with the Azure resource."
      }
    }
  ],
  "$responses": {
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_30767e1f1da9489caef8dc02a6c5778d": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_7a58a35bb2f241ab9defce966feed55a": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_044b27c06208496ea3b7d2a1da717103": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
privateEndpointConnectionName: string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}
PrivateLinkResources_ListByWorkspace (updated)
Description List the private link resources available for this workspace.
Reference Link ¶

⚶ Changes

{
  "#id": "PrivateLinkResources_ListByWorkspace",
  "$responses": {
    "200": {
      "$properties": [
        {
          "#name": "value",
          "Description": {
            "new": "The PrivateLinkResource items on this page",
            "old": "Array of private link resources"
          },
          "Required": {
            "new": true,
            "old": false
          }
        },
        {
          "#name": "nextLink",
          "Description": {
            "new": "The link to the next page of items",
            "old": "Link to the next page of results."
          }
        }
      ]
    },
    "default": {
      "Description": {
        "new": "Common error response for all Azure Resource Manager APIs to return error details for failed operations. (This also follows the OData error response format.).",
        "old": "Cloud error object."
      },
      "$properties": [
        {
          "#name": "error",
          "Description": {
            "new": "The error object.",
            "old": "Cloud error object properties."
          },
          "$properties": [
            {
              "#name": "code",
              "Description": {
                "new": "The error code.",
                "old": "Error code"
              }
            },
            {
              "#name": "message",
              "Description": {
                "new": "The error message.",
                "old": "Error message indicating why the operation failed."
              }
            },
            {
              "@added_8a07c92f50d94cd5bfe23df08d04d808": {
                "#name": "target",
                "Description": "The error target.",
                "Required": false,
                "Type": "string"
              }
            },
            {
              "@added_14f96fdb38ad4b9abb6cb9c2af0dfb01": {
                "#name": "details",
                "Description": "The error details.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Type": "string"
                }
              }
            },
            {
              "@added_b5a2c22fb403460c918917a0478bdabc": {
                "#name": "additionalInfo",
                "Description": "The error additional info.",
                "Required": false,
                "Type": "array",
                "$items": {
                  "Description": "The resource management error additional info.",
                  "Type": "object",
                  "$properties": [
                    {
                      "#name": "type",
                      "Description": "The additional info type.",
                      "Required": false,
                      "Type": "string"
                    },
                    {
                      "#name": "info",
                      "Description": "The additional info.",
                      "Required": false,
                      "Type": "object"
                    }
                  ]
                }
              }
            }
          ]
        }
      ]
    }
  }
}

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/privateLinkResources
{
api-version: string ,
subscriptionId: string ,
resourceGroupName: string ,
workspaceName: string ,
pageSize: integer ,
isDescending: boolean ,
initialSkip: integer ,
}

⚐ Response (200)

{
value:
[
{
properties:
{
groupId: string ,
requiredMembers:
[
string ,
]
,
requiredZoneNames:
[
string ,
]
,
}
,
}
,
]
,
nextLink: string ,
}

⚐ Response (default)

{
error:
{
code: string ,
message: string ,
target: string ,
details:
[
string ,
]
,
additionalInfo:
[
{
type: string ,
info: object ,
}
,
]
,
}
,
}