Existing

PreviousWorkspace NextStatus

Was this helpful?

Import

Creates an Azure Virtual Desktop Workspace from an existing Workspace.

POST/api/AVD/Workspace/Existing

Body

Azure Virtual Desktop Workspace settings.

siteIdinteger (int32)

Site ID in which to create the specified Azure Virtual Desktop Workspace. If the parameter is omitted, the Licensing Server site ID will be used.

providerId*integer (int32)

The Provider ID of the Azure Virtual Desktop Provider.

azureId*nullable string

Azure ID of existing Workspace.

Response

Created

Body

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

providerIdinteger (int32)

Provider Id

namenullable string

Name

enabledboolean

Enabled

friendlyNamenullable string

Friendly Name

descriptionnullable string

Description

resourceGroupnullable string

Resource Group

locationnullable string

Location

azureIdnullable string

Azure Id

Request

const response = await fetch('/api/AVD/Workspace/Existing', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "providerId": 1,
      "azureId": "text"
    }),
});
const data = await response.json();

Response

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-02-05T03:51:51.131Z",
  "timeLastMod": "2025-02-05T03:51:51.131Z",
  "providerId": 1,
  "name": "text",
  "enabled": true,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}