Workspace
Retrieve a list of Azure Virtual Desktop Workspaces.
the Name of the Azure Virtual Desktop Workspace
The Site ID for which to retrieve the Azure Virtual Desktop Workspace.
Success
AVD Workspace
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Provider Id
Name
Enabled
Friendly Name
Description
Resource Group
Location
Azure Id
Bad Request
Unauthorized
GET /api/AVD/Workspace HTTP/1.1
Accept: */*
[
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2026-01-01T00:00:00.000Z",
"timeLastMod": "2026-01-01T00:00:00.000Z",
"providerId": 1,
"name": "text",
"enabled": true,
"friendlyName": "text",
"description": "text",
"resourceGroup": "text",
"location": "text",
"azureId": "text"
}
]Creates a new Azure Virtual Desktop Workspace.
To create a new AVD Workspace
The name of the Azure Virtual Desktop Workspace.
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.
The Provider ID of the Azure Virtual Desktop Provider.
Description of the Azure Virtual Desktop Workspace.
Friendly name of Azure Virtual Desktop Workspace.
Resource Group of the Azure Virtual Desktop Workspace.
Location Name of the Azure Virtual Desktop Workspace.
Created
AVD Workspace
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Provider Id
Name
Enabled
Friendly Name
Description
Resource Group
Location
Azure Id
Bad Request
Unauthorized
POST /api/AVD/Workspace HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 125
{
"name": "text",
"siteId": 1,
"providerId": 1,
"description": "text",
"friendlyName": "text",
"resourceGroup": "text",
"location": "text"
}{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2026-01-01T00:00:00.000Z",
"timeLastMod": "2026-01-01T00:00:00.000Z",
"providerId": 1,
"name": "text",
"enabled": true,
"friendlyName": "text",
"description": "text",
"resourceGroup": "text",
"location": "text",
"azureId": "text"
}Retrieve the Azure Virtual Desktop Workspace.
The ID of the Azure Virtual Desktop Workspace.
Success
AVD Workspace
ID of the object.
User who created the object.
User who last modified the object.
Time when the object was created.
Time when the object was last modified.
Provider Id
Name
Enabled
Friendly Name
Description
Resource Group
Location
Azure Id
Bad Request
Unauthorized
GET /api/AVD/Workspace/{id} HTTP/1.1
Accept: */*
{
"id": 1,
"adminCreate": "text",
"adminLastMod": "text",
"timeCreate": "2026-01-01T00:00:00.000Z",
"timeLastMod": "2026-01-01T00:00:00.000Z",
"providerId": 1,
"name": "text",
"enabled": true,
"friendlyName": "text",
"description": "text",
"resourceGroup": "text",
"location": "text",
"azureId": "text"
}Modifies an Azure Virtual Desktop Workspace.
The ID of the Azure Virtual Desktop Workspace to modify.
Friendly name of Azure Virtual Desktop Workspace.
Description of Azure Virtual Desktop Workspace.
Enables or disables the Azure Virtual Desktop Workspace in site.
No Content
No content
Bad Request
Unauthorized
PUT /api/AVD/Workspace/{id} HTTP/1.1
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 58
{
"friendlyName": "text",
"description": "text",
"enable": true
}No content
Removes an Azure Virtual Desktop Workspace.
The ID of the Azure Virtual Desktop Workspace to remove.
No Content
No content
Bad Request
Unauthorized
DELETE /api/AVD/Workspace/{id} HTTP/1.1
Accept: */*
No content