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

200

Success

application/json; api-version=1.0

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

get

GET /api/AVD/Workspace/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-23T11:01:21.453Z",
  "timeLastMod": "2025-05-23T11:01:21.453Z",
  "providerId": 1,
  "name": "text",
  "enabled": true,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

Remove

delete

Removes an Azure Virtual Desktop Workspace.

Path parameters

idinteger · int32Required

The ID of the Azure Virtual Desktop Workspace to remove.

Responses

204

No Content

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

delete

DELETE /api/AVD/Workspace/{id} HTTP/1.1
Host: 
Accept: */*

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

200

Success

application/json; api-version=1.0

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

get

GET /api/AVD/Workspace HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-23T11:01:21.453Z",
    "timeLastMod": "2025-05-23T11:01:21.453Z",
    "providerId": 1,
    "name": "text",
    "enabled": true,
    "friendlyName": "text",
    "description": "text",
    "resourceGroup": "text",
    "location": "text",
    "azureId": "text"
  }
]

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

201

Created

application/json; api-version=1.0

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

post

POST /api/AVD/Workspace HTTP/1.1
Host: 
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": "2025-05-23T11:01:21.453Z",
  "timeLastMod": "2025-05-23T11:01:21.453Z",
  "providerId": 1,
  "name": "text",
  "enabled": true,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

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

204

No Content

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

put

PUT /api/AVD/Workspace/{id} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 58

{
  "friendlyName": "text",
  "description": "text",
  "enable": true
}

No content