Workspace

PreviousVirtual Network NextExisting

Was this helpful?

Get

get

Retrieve the Azure Virtual Desktop Workspace.

Path parameters

idinteger · int32required

The ID of the Azure Virtual Desktop Workspace.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/Workspace/{id}'

200

400

401

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:08:36.094Z",
  "timeLastMod": "2025-04-06T01:08:36.094Z",
  "providerId": 1,
  "name": "text",
  "enabled": true,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

Success

Remove

delete

Removes an Azure Virtual Desktop Workspace.

Path parameters

idinteger · int32required

The ID of the Azure Virtual Desktop Workspace to remove.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/Workspace/{id}'

204

400

401

No Content

List

get

Retrieve a list of Azure Virtual Desktop Workspaces.

Query parameters

namestringoptional

the Name of the Azure Virtual Desktop Workspace

siteIdinteger · int32optional

The Site ID for which to retrieve the Azure Virtual Desktop Workspace.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/Workspace'

200

400

401

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-04-06T01:08:36.094Z",
    "timeLastMod": "2025-04-06T01:08:36.094Z",
    "providerId": 1,
    "name": "text",
    "enabled": true,
    "friendlyName": "text",
    "description": "text",
    "resourceGroup": "text",
    "location": "text",
    "azureId": "text"
  }
]

Success

Create

post

Creates a new Azure Virtual Desktop Workspace.

Body

To create a new AVD Workspace

namestring | nullablerequired

The name of the Azure Virtual Desktop Workspace.

siteIdinteger · int32optional

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.

providerIdinteger · int32required

The Provider ID of the Azure Virtual Desktop Provider.

descriptionstring | nullableoptional

Description of the Azure Virtual Desktop Workspace.

friendlyNamestring | nullableoptional

Friendly name of Azure Virtual Desktop Workspace.

resourceGroupstring | nullablerequired

Resource Group of the Azure Virtual Desktop Workspace.

locationstring | nullablerequired

Location Name of the Azure Virtual Desktop Workspace.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/Workspace' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "name": "text",
    "siteId": 1,
    "providerId": 1,
    "description": "text",
    "friendlyName": "text",
    "resourceGroup": "text",
    "location": "text"
  }'

201

400

401

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-04-06T01:08:36.094Z",
  "timeLastMod": "2025-04-06T01:08:36.094Z",
  "providerId": 1,
  "name": "text",
  "enabled": true,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

Created

Update

put

Modifies an Azure Virtual Desktop Workspace.

Path parameters

idinteger · int32required

The ID of the Azure Virtual Desktop Workspace to modify.

Body

friendlyNamestring | nullableoptional

Friendly name of Azure Virtual Desktop Workspace.

descriptionstring | nullableoptional

Description of Azure Virtual Desktop Workspace.

enableboolean | nullableoptional

Enables or disables the Azure Virtual Desktop Workspace in site.

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AVD/Workspace/{id}' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "friendlyName": "text",
    "description": "text",
    "enable": true
  }'

204

400

401

No Content