{ "swagger": "2.0", "info": { "version": "2019-01-23-preview", "title": "Desktop Virtualization API Client" }, "schemes": [ "https" ], "consumes": [ "application/json" ], "produces": [ "application/json" ], "host": "management.azure.com", "securityDefinitions": { "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", "flow": "implicit", "description": "Azure Active Directory OAuth2 Flow", "scopes": { "user_impersonation": "impersonate your user account" } } }, "paths": { "/providers/Microsoft.DesktopVirtualization/operations": { "get": { "tags": [ "Operations" ], "operationId": "Operations_List", "description": "List all of the available operations the Desktop Virtualization resource provider supports.", "x-ms-examples": { "OperationDescription_List": { "$ref": "./examples/OperationDescription_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Successfully retrieved operations.", "schema": { "$ref": "#/definitions/ResourceProviderOperationList" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}": { "get": { "tags": [ "Workspace" ], "operationId": "Workspaces_Get", "description": "Get a workspace.", "x-ms-examples": { "Workspace_Get": { "$ref": "./examples/Workspace_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved workspace.", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "tags": [ "Workspace" ], "operationId": "Workspaces_CreateOrUpdate", "description": "Create or update a workspace.", "x-ms-examples": { "Workspace_Create": { "$ref": "./examples/Workspace_Create.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" }, { "name": "workspace", "description": "Object containing Workspace definitions.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Workspace" } } ], "responses": { "200": { "description": "Successfully updated workspace.", "schema": { "$ref": "#/definitions/Workspace" } }, "201": { "description": "Successfully created workspace.", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "delete": { "tags": [ "Workspace" ], "operationId": "Workspaces_Delete", "description": "Remove a workspace.", "x-ms-examples": { "Workspace_Delete": { "$ref": "./examples/Workspace_Delete.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" } ], "responses": { "200": { "description": "Successfully deleted workspace." }, "204": { "description": "Workspace does not exist." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "patch": { "tags": [ "Workspace" ], "operationId": "Workspaces_Update", "description": "Update a workspace.", "x-ms-examples": { "Workspace_Update": { "$ref": "./examples/Workspace_Update.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/WorkspaceNameParameter" }, { "name": "workspace", "description": "Object containing Workspace definitions.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/WorkspacePatch" } } ], "responses": { "200": { "description": "Successfully updated workspace.", "schema": { "$ref": "#/definitions/Workspace" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces": { "get": { "tags": [ "Workspace" ], "operationId": "Workspaces_ListByResourceGroup", "description": "List workspaces.", "x-ms-examples": { "Workspace_ListByResourceGroup": { "$ref": "./examples/Workspace_ListByResourceGroup.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved workspaces in resource group.", "schema": { "$ref": "#/definitions/WorkspaceList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/workspaces": { "get": { "tags": [ "Workspace" ], "operationId": "Workspaces_ListBySubscription", "description": "List workspaces in subscription.", "x-ms-examples": { "Workspace_ListBySubscription": { "$ref": "./examples/Workspace_ListBySubscription.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved workspaces in subscription.", "schema": { "$ref": "#/definitions/WorkspaceList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { "get": { "tags": [ "ApplicationGroup" ], "operationId": "ApplicationGroups_Get", "description": "Get an application group.", "x-ms-examples": { "ApplicationGroup_Get": { "$ref": "./examples/ApplicationGroup_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved application group.", "schema": { "$ref": "#/definitions/ApplicationGroup" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "tags": [ "ApplicationGroup" ], "operationId": "ApplicationGroups_CreateOrUpdate", "description": "Create or update an applicationGroup.", "x-ms-examples": { "ApplicationGroup_Create": { "$ref": "./examples/ApplicationGroup_Create.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "name": "applicationGroup", "description": "Object containing ApplicationGroup definitions.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/ApplicationGroup" } } ], "responses": { "200": { "description": "Successfully updated application group.", "schema": { "$ref": "#/definitions/ApplicationGroup" } }, "201": { "description": "Successfully created application group.", "schema": { "$ref": "#/definitions/ApplicationGroup" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "delete": { "tags": [ "ApplicationGroup" ], "operationId": "ApplicationGroups_Delete", "description": "Remove an applicationGroup.", "x-ms-examples": { "ApplicationGroup_Delete": { "$ref": "./examples/ApplicationGroup_Delete.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" } ], "responses": { "200": { "description": "Successfully removed application group." }, "204": { "description": "Application group does not exist." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "patch": { "tags": [ "ApplicationGroup" ], "operationId": "ApplicationGroups_Update", "description": "Update an applicationGroup.", "x-ms-examples": { "ApplicationGroups_Update": { "$ref": "./examples/ApplicationGroup_Update.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "name": "applicationGroup", "description": "Object containing ApplicationGroup definitions.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/ApplicationGroupPatch" } } ], "responses": { "200": { "description": "Successfully updated application group.", "schema": { "$ref": "#/definitions/ApplicationGroup" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups": { "get": { "tags": [ "ApplicationGroup" ], "operationId": "ApplicationGroups_ListByResourceGroup", "description": "List applicationGroups.", "x-ms-examples": { "ApplicationGroup_ListByResourceGroup": { "$ref": "./examples/ApplicationGroup_ListByResourceGroup.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "OData filter expression. Valid properties for filtering are applicationGroupType." } ], "responses": { "200": { "description": "Successfully retrieved application groups in resource group.", "schema": { "$ref": "#/definitions/ApplicationGroupList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/applicationGroups": { "get": { "tags": [ "ApplicationGroup" ], "operationId": "ApplicationGroups_ListBySubscription", "description": "List applicationGroups in subscription.", "x-ms-examples": { "ApplicationGroup_List": { "$ref": "./examples/ApplicationGroup_ListBySubscription.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "OData filter expression. Valid properties for filtering are applicationGroupType." } ], "responses": { "200": { "description": "Successfully retrieved application groups in subscription.", "schema": { "$ref": "#/definitions/ApplicationGroupList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/startMenuItems": { "get": { "tags": [ "StartMenuItem" ], "operationId": "StartMenuItems_List", "description": "List start menu items in the given application group.", "x-ms-examples": { "StartMenuItem_List": { "$ref": "./examples/StartMenuItem_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved start menu items in application group.", "schema": { "$ref": "#/definitions/StartMenuItemList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications/{applicationName}": { "get": { "tags": [ "Application" ], "operationId": "Applications_Get", "description": "Get an application.", "x-ms-examples": { "Application_Get": { "$ref": "./examples/Application_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "$ref": "#/parameters/ApplicationNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved application.", "schema": { "$ref": "#/definitions/Application" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "tags": [ "Application" ], "operationId": "Applications_CreateOrUpdate", "description": "Create or update an application.", "x-ms-examples": { "Application_Create": { "$ref": "./examples/Application_Create.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "$ref": "#/parameters/ApplicationNameParameter" }, { "name": "application", "description": "Object containing Application definitions.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/Application" } } ], "responses": { "200": { "description": "Successfully updated application.", "schema": { "$ref": "#/definitions/Application" } }, "201": { "description": "Successfully created application.", "schema": { "$ref": "#/definitions/Application" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "delete": { "tags": [ "Application" ], "operationId": "Applications_Delete", "description": "Remove an application.", "x-ms-examples": { "Application_Delete": { "$ref": "./examples/Application_Delete.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "$ref": "#/parameters/ApplicationNameParameter" } ], "responses": { "200": { "description": "Successfully removed application." }, "204": { "description": "Application does not exist." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "patch": { "tags": [ "Application" ], "operationId": "Applications_Update", "description": "Update an application.", "x-ms-examples": { "Application_Update": { "$ref": "./examples/Application_Update.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "$ref": "#/parameters/ApplicationNameParameter" }, { "name": "application", "description": "Object containing Application definitions.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/ApplicationPatch" } } ], "responses": { "200": { "description": "Successfully updated application.", "schema": { "$ref": "#/definitions/Application" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/applications": { "get": { "tags": [ "Application" ], "operationId": "Applications_List", "description": "List applications.", "x-ms-examples": { "Applications_List": { "$ref": "./examples/Application_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved applications in application group.", "schema": { "$ref": "#/definitions/ApplicationList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops/{desktopName}": { "get": { "tags": [ "Desktop" ], "operationId": "Desktops_Get", "description": "Get a desktop.", "x-ms-examples": { "Desktop_Get": { "$ref": "./examples/Desktop_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "$ref": "#/parameters/DesktopNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved desktop.", "schema": { "$ref": "#/definitions/Desktop" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "patch": { "tags": [ "Desktop" ], "operationId": "Desktops_Update", "description": "Update a desktop.", "x-ms-examples": { "Desktop_Update": { "$ref": "./examples/Desktop_Update.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" }, { "$ref": "#/parameters/DesktopNameParameter" }, { "name": "desktop", "description": "Object containing Desktop definitions.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/DesktopPatch" } } ], "responses": { "200": { "description": "Successfully updated desktop.", "schema": { "$ref": "#/definitions/Desktop" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}/desktops": { "get": { "tags": [ "Desktop" ], "operationId": "Desktops_List", "description": "List desktops.", "x-ms-examples": { "Desktop_List": { "$ref": "./examples/Desktop_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/ApplicationGroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved desktops in application group.", "schema": { "$ref": "#/definitions/DesktopList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}": { "get": { "tags": [ "HostPool" ], "operationId": "HostPools_Get", "description": "Get a host pool.", "x-ms-examples": { "HostPool_Get": { "$ref": "./examples/HostPool_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved host pool.", "schema": { "$ref": "#/definitions/HostPool" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "put": { "tags": [ "HostPool" ], "operationId": "HostPools_CreateOrUpdate", "description": "Create or update a host pool.", "x-ms-examples": { "HostPool_Create": { "$ref": "./examples/HostPool_Create.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "name": "hostPool", "description": "Object containing HostPool definitions.", "in": "body", "required": true, "schema": { "$ref": "#/definitions/HostPool" } } ], "responses": { "200": { "description": "Successfully updated host pool.", "schema": { "$ref": "#/definitions/HostPool" } }, "201": { "description": "Successfully created host pool.", "schema": { "$ref": "#/definitions/HostPool" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "delete": { "tags": [ "HostPool" ], "operationId": "HostPools_Delete", "description": "Remove a host pool.", "x-ms-examples": { "HostPool_Delete": { "$ref": "./examples/HostPool_Delete.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "name": "force", "in": "query", "required": false, "type": "boolean", "description": "Force flag to delete sessionHost." } ], "responses": { "200": { "description": "Successfully removed host pool." }, "204": { "description": "Host pool does not exist." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "patch": { "tags": [ "HostPool" ], "operationId": "HostPools_Update", "description": "Update a host pool.", "x-ms-examples": { "HostPool_Update": { "$ref": "./examples/HostPool_Update.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "name": "hostPool", "description": "Object containing HostPool definitions.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/HostPoolPatch" } } ], "responses": { "200": { "description": "Successfully updated host pool.", "schema": { "$ref": "#/definitions/HostPool" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools": { "get": { "tags": [ "HostPool" ], "operationId": "HostPools_ListByResourceGroup", "description": "List hostPools.", "x-ms-examples": { "HostPool_ListByResourceGroup": { "$ref": "./examples/HostPool_ListByResourceGroup.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved host pool in resource group.", "schema": { "$ref": "#/definitions/HostPoolList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/providers/Microsoft.DesktopVirtualization/hostPools": { "get": { "tags": [ "HostPool" ], "operationId": "HostPools_List", "description": "List hostPools in subscription.", "x-ms-examples": { "HostPool_List": { "$ref": "./examples/HostPool_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved host pool in subscription.", "schema": { "$ref": "#/definitions/HostPoolList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/userSessions": { "get": { "tags": [ "UserSession" ], "operationId": "UserSessions_ListByHostPool", "description": "List userSessions.", "x-ms-examples": { "UserSession_ListByHostPool": { "$ref": "./examples/UserSession_ListByHostPool.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "name": "$filter", "in": "query", "required": false, "type": "string", "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." } ], "responses": { "200": { "description": "Successfully retrieved user sessions in host pool.", "schema": { "$ref": "#/definitions/UserSessionList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}": { "get": { "tags": [ "SessionHost" ], "operationId": "SessionHosts_Get", "description": "Get a session host.", "x-ms-examples": { "SessionHost_Get": { "$ref": "./examples/SessionHost_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved session host.", "schema": { "$ref": "#/definitions/SessionHost" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "delete": { "tags": [ "SessionHost" ], "operationId": "SessionHosts_Delete", "description": "Remove a SessionHost.", "x-ms-examples": { "SessionHost_Delete": { "$ref": "./examples/SessionHost_Delete.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" }, { "name": "force", "in": "query", "required": false, "type": "boolean", "description": "Force flag to force sessionHost deletion even when userSession exists." } ], "responses": { "200": { "description": "Successfully removed session host." }, "204": { "description": "Session host does not exist." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "patch": { "tags": [ "SessionHost" ], "operationId": "SessionHosts_Update", "description": "Update a session host.", "x-ms-examples": { "SessionHost_Update": { "$ref": "./examples/SessionHost_Update.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" }, { "name": "sessionHost", "description": "Object containing SessionHost definitions.", "in": "body", "required": false, "schema": { "$ref": "#/definitions/SessionHostPatch" } } ], "responses": { "200": { "description": "Successfully updated session host.", "schema": { "$ref": "#/definitions/SessionHost" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts": { "get": { "tags": [ "SessionHost" ], "operationId": "SessionHosts_List", "description": "List sessionHosts.", "x-ms-examples": { "SessionHost_List": { "$ref": "./examples/SessionHost_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved session hosts in host pool.", "schema": { "$ref": "#/definitions/SessionHostList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { "get": { "tags": [ "UserSession" ], "operationId": "UserSessions_Get", "description": "Get a userSession.", "x-ms-examples": { "UserSession_Get": { "$ref": "./examples/UserSession_Get.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" }, { "$ref": "#/parameters/UserSessionIdParameter" } ], "responses": { "200": { "description": "Successfully retrieved user session.", "schema": { "$ref": "#/definitions/UserSession" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } }, "delete": { "tags": [ "UserSession" ], "operationId": "UserSessions_Delete", "description": "Remove a userSession.", "x-ms-examples": { "UserSession_Delete": { "$ref": "./examples/UserSession_Delete.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" }, { "$ref": "#/parameters/UserSessionIdParameter" }, { "name": "force", "in": "query", "required": false, "type": "boolean", "description": "Force flag to login off userSession." } ], "responses": { "200": { "description": "Successfully removed user session." }, "204": { "description": "User session does not exist." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions": { "get": { "tags": [ "UserSession" ], "operationId": "UserSessions_List", "description": "List userSessions.", "x-ms-examples": { "UserSession_List": { "$ref": "./examples/UserSession_List.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" } ], "responses": { "200": { "description": "Successfully retrieved user sessions in session host.", "schema": { "$ref": "#/definitions/UserSessionList" } }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } }, "x-ms-pageable": { "nextLinkName": "nextLink" } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/disconnect": { "post": { "tags": [ "UserSession" ], "operationId": "UserSessions_Disconnect", "description": "Disconnect a userSession.", "x-ms-examples": { "UserSession_Disconnect_Post": { "$ref": "./examples/UserSession_Disconnect_Post.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" }, { "$ref": "#/parameters/UserSessionIdParameter" } ], "responses": { "200": { "description": "Successfully disconnected user session." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}/sendMessage": { "post": { "tags": [ "UserSession" ], "operationId": "UserSessions_SendMessage", "description": "Send a message to a user.", "x-ms-examples": { "UserSession_SendMessage_Post": { "$ref": "./examples/UserSession_SendMessage_Post.json" } }, "parameters": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" }, { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" }, { "$ref": "#/parameters/HostPoolNameParameter" }, { "$ref": "#/parameters/SessionHostNameParameter" }, { "$ref": "#/parameters/UserSessionIdParameter" }, { "name": "sendMessage", "description": "Object containing message includes title and message body", "in": "body", "required": false, "schema": { "$ref": "#/definitions/SendMessage" } } ], "responses": { "200": { "description": "Successfully sent message to user session." }, "default": { "description": "Automation error response describing why the operation failed.", "schema": { "$ref": "#/definitions/CloudError" } } } } } }, "definitions": { "CloudError": { "type": "object", "properties": { "code": { "description": "Error code", "type": "string" }, "message": { "description": "Error message indicating why the operation failed.", "type": "string" } }, "description": "Error response of an operation failure" }, "ResourceProviderOperationList": { "description": "Result of the request to list operations.", "readOnly": true, "properties": { "value": { "type": "array", "items": { "$ref": "#/definitions/ResourceProviderOperation" }, "description": "List of operations supported by this resource provider." } } }, "ResourceProviderOperation": { "description": "Supported operation of this resource provider.", "readOnly": true, "properties": { "name": { "description": "Operation name, in format of {provider}/{resource}/{operation}", "type": "string" }, "display": { "description": "Display metadata associated with the operation.", "properties": { "provider": { "description": "Resource provider: Microsoft Desktop Virtualization.", "type": "string" }, "resource": { "description": "Resource on which the operation is performed.", "type": "string" }, "operation": { "description": "Type of operation: get, read, delete, etc.", "type": "string" }, "description": { "description": "Description of this operation.", "type": "string" } } } } }, "Workspace": { "type": "object", "description": "Represents a Workspace definition.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "properties": { "properties": { "description": "Detailed properties for Workspace", "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspaceProperties" } } }, "WorkspaceProperties": { "description": "Schema for Workspace properties.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of Workspace." }, "friendlyName": { "type": "string", "description": "Friendly name of Workspace." }, "applicationGroupReferences": { "type": "array", "description": "List of applicationGroup resource Ids.", "items": { "type": "string" } } } }, "WorkspaceList": { "type": "object", "title": "WorkspaceList", "description": "List of Workspace definitions.", "properties": { "value": { "type": "array", "description": "List of Workspace definitions.", "items": { "$ref": "#/definitions/Workspace" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "WorkspacePatch": { "type": "object", "description": "Workspace properties that can be patched.", "properties": { "tags": { "type": "object", "description": "tags to be updated" }, "properties": { "description": "Detailed properties for Workspace", "x-ms-client-flatten": true, "$ref": "#/definitions/WorkspacePatchProperties" } } }, "WorkspacePatchProperties": { "description": "Workspace properties that can be patched.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of Workspace." }, "friendlyName": { "type": "string", "description": "Friendly name of Workspace." }, "applicationGroupReferences": { "type": "array", "description": "List of applicationGroup links.", "items": { "type": "string" } } } }, "ApplicationGroup": { "type": "object", "description": "Represents a ApplicationGroup definition.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "required": [ "properties" ], "properties": { "properties": { "description": "Detailed properties for ApplicationGroup", "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGroupProperties" } } }, "ApplicationGroupProperties": { "description": "Schema for ApplicationGroup properties.", "type": "object", "required": [ "hostPoolArmPath", "applicationGroupType" ], "properties": { "description": { "type": "string", "description": "Description of ApplicationGroup." }, "friendlyName": { "type": "string", "description": "Friendly name of ApplicationGroup." }, "hostPoolArmPath": { "type": "string", "description": "HostPool arm path of ApplicationGroup.", "x-nullable": false }, "workspaceArmPath": { "type": "string", "description": "Workspace arm path of ApplicationGroup.", "readOnly": true }, "applicationGroupType": { "enum": [ "RemoteApp", "Desktop" ], "x-ms-enum": { "name": "ApplicationGroupType", "modelAsString": true }, "type": "string", "description": "Resource Type of ApplicationGroup.", "x-nullable": false } } }, "ApplicationGroupPatch": { "type": "object", "description": "ApplicationGroup properties that can be patched.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "tags": { "type": "object", "description": "tags to be updated" }, "properties": { "description": "ApplicationGroup properties that can be patched.", "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationGroupPatchProperties" } } }, "ApplicationGroupPatchProperties": { "description": "ApplicationGroup properties that can be patched.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of ApplicationGroup." }, "friendlyName": { "type": "string", "description": "Friendly name of ApplicationGroup." } } }, "ApplicationGroupList": { "type": "object", "title": "ApplicationGroupList", "description": "List of ApplicationGroup definitions.", "properties": { "value": { "type": "array", "description": "List of ApplicationGroup definitions.", "items": { "$ref": "#/definitions/ApplicationGroup" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "HostPool": { "type": "object", "description": "Represents a HostPool definition.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "required": [ "properties" ], "properties": { "properties": { "description": "Detailed properties for HostPool", "x-ms-client-flatten": true, "$ref": "#/definitions/HostPoolProperties" } } }, "HostPoolProperties": { "description": "Properties of HostPool.", "type": "object", "required": [ "hostPoolType", "loadBalancerType", "preferredAppGroupType" ], "properties": { "friendlyName": { "type": "string", "description": "Friendly name of HostPool." }, "description": { "type": "string", "description": "Description of HostPool." }, "hostPoolType": { "enum": [ "Personal", "Shared" ], "x-ms-enum": { "name": "HostPoolType", "modelAsString": true }, "type": "string", "description": "HostPool type for desktop.", "x-nullable": false }, "personalDesktopAssignmentType": { "enum": [ "Automatic", "Direct" ], "x-ms-enum": { "name": "PersonalDesktopAssignmentType", "modelAsString": true }, "type": "string", "description": "PersonalDesktopAssignment type for HostPool.", "x-nullable": false }, "customRdpProperty": { "type": "string", "description": "Custom rdp property of HostPool." }, "maxSessionLimit": { "type": "integer", "description": "The max session limit of HostPool." }, "loadBalancerType": { "enum": [ "BreadthFirst", "DepthFirst", "Persistent" ], "x-ms-enum": { "name": "LoadBalancerType", "modelAsString": true }, "type": "string", "description": "The type of the load balancer.", "x-nullable": false }, "ring": { "type": "integer", "description": "The ring number of HostPool." }, "validationEnvironment": { "type": "boolean", "description": "Is validation environment." }, "registrationInfo": { "$ref": "#/definitions/RegistrationInfo", "description": "The registration info of HostPool." }, "vmTemplate": { "type": "string", "description": "VM template for sessionhosts configuration within hostpool." }, "applicationGroupReferences": { "readOnly": true, "type": "array", "description": "List of applicationGroup links.", "items": { "type": "string" } }, "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." }, "preferredAppGroupType": { "enum": [ "None", "Desktop", "RailApplications" ], "x-ms-enum": { "name": "PreferredAppGroupType", "modelAsString": true }, "type": "string", "description": "The type of preferred application group type, default to Desktop Application Group", "x-nullable": false } } }, "HostPoolPatch": { "type": "object", "description": "HostPool properties that can be patched.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "tags": { "type": "object", "description": "tags to be updated" }, "properties": { "description": "HostPool properties that can be patched.", "x-ms-client-flatten": true, "$ref": "#/definitions/HostPoolPatchProperties" } } }, "HostPoolPatchProperties": { "description": "Properties of HostPool.", "type": "object", "properties": { "friendlyName": { "type": "string", "description": "Friendly name of HostPool." }, "description": { "type": "string", "description": "Description of HostPool." }, "customRdpProperty": { "type": "string", "description": "Custom rdp property of HostPool." }, "maxSessionLimit": { "type": "integer", "description": "The max session limit of HostPool." }, "personalDesktopAssignmentType": { "enum": [ "Automatic", "Direct" ], "x-ms-enum": { "name": "PersonalDesktopAssignmentType", "modelAsString": true }, "type": "string", "description": "PersonalDesktopAssignment type for HostPool." }, "loadBalancerType": { "enum": [ "BreadthFirst", "DepthFirst", "Persistent" ], "x-ms-enum": { "name": "LoadBalancerType", "modelAsString": true }, "type": "string", "description": "The type of the load balancer." }, "ring": { "type": "integer", "description": "The ring number of HostPool." }, "validationEnvironment": { "type": "boolean", "description": "Is validation environment." }, "registrationInfo": { "$ref": "#/definitions/RegistrationInfoPatch", "description": "The registration info of HostPool." }, "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." }, "preferredAppGroupType": { "enum": [ "None", "Desktop", "RailApplications" ], "x-ms-enum": { "name": "PreferredAppGroupType", "modelAsString": true }, "type": "string", "description": "The type of preferred application group type, default to Desktop Application Group" } } }, "RegistrationInfo": { "description": "Represents a RegistrationInfo definition.", "type": "object", "properties": { "expirationTime": { "format": "date-time", "type": "string", "description": "Expiration time of registration token." }, "token": { "type": "string", "description": "The registration token base64 encoded string." }, "resetToken": { "type": "boolean", "description": "Update registration token." } } }, "RegistrationInfoPatch": { "description": "Represents a RegistrationInfo definition.", "type": "object", "properties": { "resetToken": { "type": "boolean", "description": "Update registration token." } } }, "SendMessage": { "description": "Represents message sent to a UserSession.", "type": "object", "properties": { "messageTitle": { "type": "string", "description": "Title of message." }, "messageBody": { "type": "string", "description": "Body of message." } } }, "HostPoolList": { "type": "object", "title": "HostPoolList", "description": "List of HostPool definitions.", "properties": { "value": { "type": "array", "description": "List of HostPool definitions.", "items": { "$ref": "#/definitions/HostPool" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "Application": { "description": "Schema for Application properties.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "required": [ "properties" ], "properties": { "properties": { "description": "Detailed properties for Application", "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationProperties" } } }, "ApplicationProperties": { "description": "Schema for Application properties.", "type": "object", "required": [ "commandLineSetting" ], "properties": { "description": { "type": "string", "description": "Description of Application." }, "friendlyName": { "type": "string", "description": "Friendly name of Application." }, "filePath": { "type": "string", "description": "Specifies a path for the executable file for the application." }, "commandLineSetting": { "enum": [ "DoNotAllow", "Allow", "Require" ], "x-ms-enum": { "name": "CommandLineSetting", "modelAsString": true }, "type": "string", "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all.", "x-nullable": false }, "commandLineArguments": { "type": "string", "description": "Command Line Arguments for Application." }, "showInPortal": { "type": "boolean", "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." }, "iconPath": { "type": "string", "description": "Path to icon." }, "iconIndex": { "type": "integer", "description": "Index of the icon." }, "iconHash": { "readOnly": true, "type": "string", "description": "Hash of the icon." }, "iconContent": { "readOnly": true, "type": "string", "format": "byte", "description": "the icon a 64 bit string as a byte array." } } }, "ApplicationList": { "type": "object", "title": "ApplicationList", "description": "List of Application definitions.", "properties": { "value": { "type": "array", "description": "List of Application definitions.", "items": { "$ref": "#/definitions/Application" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "ApplicationPatch": { "type": "object", "description": "Application properties that can be patched.", "properties": { "tags": { "type": "object", "description": "tags to be updated" }, "properties": { "description": "Detailed properties for Application", "x-ms-client-flatten": true, "$ref": "#/definitions/ApplicationPatchProperties" } } }, "ApplicationPatchProperties": { "description": "Application properties that can be patched.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of Application." }, "friendlyName": { "type": "string", "description": "Friendly name of Application." }, "filePath": { "type": "string", "description": "Specifies a path for the executable file for the application." }, "commandLineSetting": { "enum": [ "DoNotAllow", "Allow", "Require" ], "x-ms-enum": { "name": "CommandLineSetting", "modelAsString": true }, "type": "string", "description": "Specifies whether this published application can be launched with command line arguments provided by the client, command line arguments specified at publish time, or no command line arguments at all." }, "commandLineArguments": { "type": "string", "description": "Command Line Arguments for Application." }, "showInPortal": { "type": "boolean", "description": "Specifies whether to show the RemoteApp program in the RD Web Access server." }, "iconPath": { "type": "string", "description": "Path to icon." }, "iconIndex": { "type": "integer", "description": "Index of the icon." } } }, "Desktop": { "description": "Schema for Desktop properties.", "type": "object", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "properties": { "description": "Detailed properties for Desktop", "x-ms-client-flatten": true, "$ref": "#/definitions/DesktopProperties" } } }, "DesktopProperties": { "description": "Schema for Desktop properties.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of Desktop." }, "friendlyName": { "type": "string", "description": "Friendly name of Desktop." }, "iconHash": { "readOnly": true, "type": "string", "description": "Hash of the icon." }, "iconContent": { "readOnly": true, "type": "string", "format": "byte", "description": "The icon a 64 bit string as a byte array." } } }, "DesktopList": { "type": "object", "title": "DesktopList", "description": "List of Desktop definitions.", "properties": { "value": { "type": "array", "description": "List of Desktop definitions.", "items": { "$ref": "#/definitions/Desktop" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "DesktopPatch": { "type": "object", "description": "Desktop properties that can be patched.", "properties": { "tags": { "type": "object", "description": "tags to be updated" }, "properties": { "description": "Detailed properties for Desktop", "x-ms-client-flatten": true, "$ref": "#/definitions/DesktopPatchProperties" } } }, "DesktopPatchProperties": { "description": "Desktop properties that can be patched.", "type": "object", "properties": { "description": { "type": "string", "description": "Description of Desktop." }, "friendlyName": { "type": "string", "description": "Friendly name of Desktop." } } }, "StartMenuItemProperties": { "description": "Schema for StartMenuItem properties.", "type": "object", "properties": { "appAlias": { "type": "string", "description": "Alias of StartMenuItem." }, "friendlyName": { "type": "string", "description": "Friendly name of StartMenuItem." }, "filePath": { "type": "string", "description": "Path to the file of StartMenuItem." }, "commandLineArguments": { "type": "string", "description": "Command line arguments for StartMenuItem." }, "iconPath": { "type": "string", "description": "Path to the icon." }, "iconIndex": { "type": "integer", "description": "Index of the icon." } } }, "StartMenuItem": { "type": "object", "description": "Represents a StartMenuItem definition.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "properties": { "description": "Detailed properties for StartMenuItem", "x-ms-client-flatten": true, "$ref": "#/definitions/StartMenuItemProperties" } } }, "StartMenuItemList": { "type": "object", "title": "StartMenuItemList", "description": "List of StartMenuItem definitions.", "properties": { "value": { "type": "array", "description": "List of StartMenuItem definitions.", "items": { "$ref": "#/definitions/StartMenuItem" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "SessionHost": { "type": "object", "description": "Represents a SessionHost definition.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "properties": { "description": "Detailed properties for SessionHost", "x-ms-client-flatten": true, "$ref": "#/definitions/SessionHostProperties" } } }, "SessionHostProperties": { "description": "Schema for SessionHost properties.", "type": "object", "properties": { "lastHeartBeat": { "format": "date-time", "type": "string", "description": "Last heart beat from SessionHost." }, "sessions": { "type": "integer", "description": "Number of sessions on SessionHost." }, "agentVersion": { "type": "string", "description": "Version of agent on SessionHost." }, "allowNewSession": { "type": "boolean", "description": "Allow a new session." }, "virtualMachineId": { "type": "string", "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", "readOnly": true }, "resourceId": { "type": "string", "description": "Resource Id of SessionHost's underlying virtual machine.", "readOnly": true }, "assignedUser": { "type": "string", "description": "User assigned to SessionHost." }, "status": { "enum": [ "Available", "Unavailable", "Shutdown", "Disconnected", "Upgrading", "UpgradeFailed" ], "x-ms-enum": { "name": "Status", "modelAsString": true }, "type": "string", "description": "Status for a SessionHost." }, "statusTimestamp": { "format": "date-time", "type": "string", "description": "The timestamp of the status.", "readOnly": true }, "osVersion": { "type": "string", "description": "The version of the OS on the session host." }, "sxSStackVersion": { "type": "string", "description": "The version of the side by side stack on the session host." }, "updateState": { "enum": [ "Initial", "Pending", "Started", "Succeeded", "Failed" ], "x-ms-enum": { "name": "UpdateState", "modelAsString": true }, "type": "string", "description": "Update state of a SessionHost." }, "lastUpdateTime": { "format": "date-time", "type": "string", "description": "The timestamp of the last update.", "readOnly": true }, "updateErrorMessage": { "type": "string", "description": "The error message." } } }, "SessionHostPatch": { "type": "object", "description": "SessionHost properties that can be patched.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "properties": { "description": "Detailed properties for SessionHost", "x-ms-client-flatten": true, "$ref": "#/definitions/SessionHostPatchProperties" } } }, "SessionHostPatchProperties": { "description": "SessionHost properties that can be patched.", "type": "object", "properties": { "allowNewSession": { "type": "boolean", "description": "Allow a new session." }, "assignedUser": { "type": "string", "description": "User assigned to SessionHost." } } }, "SessionHostList": { "type": "object", "title": "SessionHostList", "description": "List of SessionHost definitions.", "properties": { "value": { "type": "array", "description": "List of SessionHost definitions.", "items": { "$ref": "#/definitions/SessionHost" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } }, "UserSession": { "type": "object", "description": "Represents a UserSession definition.", "allOf": [ { "$ref": "../../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" } ], "properties": { "properties": { "description": "Detailed properties for UserSession", "x-ms-client-flatten": true, "$ref": "#/definitions/UserSessionProperties" } } }, "UserSessionProperties": { "description": "Schema for UserSession properties.", "type": "object", "properties": { "userPrincipalName": { "type": "string", "description": "The user principal name." }, "applicationType": { "enum": [ "RemoteApp", "Desktop" ], "x-ms-enum": { "name": "ApplicationType", "modelAsString": true }, "type": "string", "description": "Application type of application." }, "sessionState": { "enum": [ "Unknown", "Active", "Disconnected", "Pending", "LogOff", "UserProfileDiskMounted" ], "x-ms-enum": { "name": "SessionState", "modelAsString": true }, "type": "string", "description": "State of user session." }, "activeDirectoryUserName": { "type": "string", "description": "The active directory user name." }, "createTime": { "format": "date-time", "type": "string", "description": "The timestamp of the user session create." } } }, "UserSessionList": { "type": "object", "title": "UserSessionList", "description": "List of UserSession definitions.", "properties": { "value": { "type": "array", "description": "List of UserSession definitions.", "items": { "$ref": "#/definitions/UserSession" } }, "nextLink": { "type": "string", "readOnly": true, "description": "Link to the next page of results." } } } }, "parameters": { "HostPoolNameParameter": { "name": "hostPoolName", "in": "path", "required": true, "type": "string", "description": "The name of the host pool within the specified resource group", "maxLength": 24, "minLength": 3, "x-ms-parameter-location": "method" }, "ApplicationGroupNameParameter": { "name": "applicationGroupName", "in": "path", "required": true, "type": "string", "description": "The name of the application group", "maxLength": 24, "minLength": 3, "x-ms-parameter-location": "method" }, "ApplicationNameParameter": { "name": "applicationName", "in": "path", "required": true, "type": "string", "description": "The name of the application within the specified application group", "maxLength": 24, "minLength": 3, "x-ms-parameter-location": "method" }, "DesktopNameParameter": { "name": "desktopName", "in": "path", "required": true, "type": "string", "description": "The name of the desktop within the specified desktop group", "maxLength": 24, "minLength": 3, "x-ms-parameter-location": "method" }, "WorkspaceNameParameter": { "name": "workspaceName", "in": "path", "required": true, "type": "string", "description": "The name of the workspace", "maxLength": 24, "minLength": 3, "x-ms-parameter-location": "method" }, "SessionHostNameParameter": { "name": "sessionHostName", "in": "path", "required": true, "type": "string", "description": "The name of the session host within the specified host pool", "maxLength": 48, "minLength": 3, "x-ms-parameter-location": "method" }, "UserSessionIdParameter": { "name": "userSessionId", "in": "path", "required": true, "type": "string", "description": "The name of the user session within the specified session host", "maxLength": 24, "minLength": 1, "x-ms-parameter-location": "method" }, "StartMenuItemNameParameter": { "name": "startMenuItemName", "in": "path", "required": true, "type": "string", "description": "The name of the start menu item within the specified host pool", "maxLength": 24, "minLength": 3, "x-ms-parameter-location": "method" } } }