Workspace

List

Retrieve a list of Azure Virtual Desktop Workspaces.

GET/api/AVD/Workspace

Query parameters

Response

200400401

Success

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

const response = await fetch('/api/AVD/Workspace', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T14:10:25.090Z",
    "timeLastMod": "2024-12-21T14:10:25.090Z",
    "providerId": 0,
    "name": "text",
    "enabled": false,
    "friendlyName": "text",
    "description": "text",
    "resourceGroup": "text",
    "location": "text",
    "azureId": "text"
  }
]

Create

Creates a new Azure Virtual Desktop Workspace.

POST/api/AVD/Workspace

Body

application/json; api-version=1.0

Azure Virtual Desktop Workspace settings.

name*nullable string

The name of the Azure Virtual Desktop Workspace.

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.

descriptionnullable string

Description of the Azure Virtual Desktop Workspace.

friendlyNamenullable string

Friendly name of Azure Virtual Desktop Workspace.

resourceGroup*nullable string

Resource Group of the Azure Virtual Desktop Workspace.

location*nullable string

Location Name of the Azure Virtual Desktop Workspace.

Response

201400401

Created

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

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

Response

201400401

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:10:25.090Z",
  "timeLastMod": "2024-12-21T14:10:25.090Z",
  "providerId": 0,
  "name": "text",
  "enabled": false,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

Get

Retrieve the Azure Virtual Desktop Workspace.

GET/api/AVD/Workspace/{id}

Path parameters

id*integer (int32)

The ID of the Azure Virtual Desktop Workspace.

Response

200400401

Success

Body

application/json; api-version=1.0

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

JavaScriptCurlPython

const response = await fetch('/api/AVD/Workspace/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200400401

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:10:25.090Z",
  "timeLastMod": "2024-12-21T14:10:25.090Z",
  "providerId": 0,
  "name": "text",
  "enabled": false,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

Update

Modifies an Azure Virtual Desktop Workspace.

PUT/api/AVD/Workspace/{id}

Path parameters

id*integer (int32)

The ID of the Azure Virtual Desktop Workspace to modify.

Body

application/json; api-version=1.0

Azure Virtual Desktop Workspace settings.

friendlyNamenullable string

Friendly name of Azure Virtual Desktop Workspace.

descriptionnullable string

Description of Azure Virtual Desktop Workspace.

enablenullable boolean

Enables or disables the Azure Virtual Desktop Workspace in site.

Response

204400401

No Content

Request

JavaScriptCurlPython

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

Response

400401

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}

Remove

Removes an Azure Virtual Desktop Workspace.

DELETE/api/AVD/Workspace/{id}

Path parameters

id*integer (int32)

The ID of the Azure Virtual Desktop Workspace to remove.

Response

204400401

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/AVD/Workspace/{id}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

400401

{
  "type": "text",
  "title": "text",
  "status": 0,
  "detail": "text",
  "instance": "text"
}