1 of 100

Parallels REST API

About

Overview

Parallels RAS comes with various APIs to help you develop custom applications that integrate with it. The RAS REST API is one of them. This guide describes how to use the REST API and documents the available REST resources, complete with request syntax and examples.

Getting Started

Applications communicate with Parallels RAS by sending HTTP or HTTPS requests. Parallels RAS answers with a JSON file in a response to every HTTP request.

All HTTP requests that you will use to retrieve and manage Parallels RAS resources have the following base structure:

https://<API-host>:20443/api/<URI>

where:

<API-host> is the IP address or FQDN of the server on which the RAS REST API endpoint is installed.
<URI> is a path to a REST resource that you would like to work with. The available resources and their paths and possible parameters are described in the OPERATIONS section. Request body schemas are documented in the SCHEMA DEFINITIONS section.

Logging in and Sending Requests

This section contains an example of RAS REST API usage that can help you quickly get started. The example demonstrates how to:

Login to Parallels RAS and obtain an authentication token.
Retrieve the information about all available RD Session Hosts.
Retrieve the information about a specific RD Session Host.
Modify RD Session Host properties.

Log in to Parallels RAS and obtain an authorization token

Before you can access any of the resources, you need to log in to Parallels RAS using administrator credentials and obtain an authorization token. This is accomplished by sending the following request:

POST https://<API-host>:20443/api/session/logon

Request headers

The logon request must contain just the Content-Type request header. Subsequent requests must additionally contain the auth_token header, as you'll see in the examples that follow this one.

Content-Type: application/json; api-version=1.0

Request body

The request body must contain the RAS administrator user name and password:

{
 "username": "USER",
 "password": "PASSWORD"
}

Response

After sending the logon request, you will receive a reply containing the authentication token, which you will use in all subsequent requests:

{
 "authToken": "[AUTHENTICATION_TOKEN]"
}

Throughout this document, AUTHENTICATION_TOKEN refers to the authentication token, which can be obtained from /api/session/logon.

Retrieve information about RD Session Hosts

Now that we have the authentication token, we can send requests to access various resources. In this example we'll first obtain the information about all available RD Session Hosts. In the example that follows, we'll obtain the information about a specific RD Session Host.

To retrieve the RD Session Host info, send the following request:

GET https://<API-host>:20443/api/RDS

Request headers

This time the auth_token request header must also be included and must contain the authentication token that we've obtained earlier:

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Response

The response will look similar to the following (with multiple RD Session Hosts in the farm, each block of the result set will contain the information about an individual server):

{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
"inheritDefaultPrinterSettings": true,
"inheritDefaultUPDSettings": true,
"inheritDefaultDesktopAccessSettings": true,
"port": 3389,
…
"restrictDesktopAccess": false,
"restrictedUsers": [],
"server": "IP_ADDR",
"enabled": true,
"description": "",
"siteId": 1,
"id": 2
}

Retrieve information about a specific RD Session Host

To retrieve the information about a specific server, we'll use the same request as above but will add the server ID in the end:

GET https://<API-host>:20443/api/RDS/2/

The response will also be similar to the example above and will contain the information just for the specified server.

Modify RD Session Host properties

In this example we'll modify a property of the RD Session Host that we retrieved earlier. For simplicity let's modify the "description" field.

The request to modify properties of an RD Session Host has the following syntax:

PUT https://<API-host>:20443/api/RDS/2/

Note "2" at the end of the request, which specifies the ID of the RD Session Host that we want to modify.

Request headers

Content-Type: application/json; api-version=1.0
auth_token: [AUTHENTICATION_TOKEN]

Request body

{
"description": "description was updated!"
}

Response

If the PUT request succeeds, you will get an empty response with code "204: No Content". To verify that the "description" field was in fact modified, let's use the same GET request that we used earlier:

GET https://<API-host>:20443/api/RDS/2/

As we can see, the result now contains the updated "description" field:

{
"directAddress": "IP_ADDR",
"rasTemplateId": 0,
"inheritDefaultAgentSettings": true,
…
"server": "IP_ADDR",
"enabled": true,
"description": "description was updated!",
"siteId": 1,
"id": 2
}

Examples

Below you can find some samples containing sequences of different types of HTTP requests:

API reference

Infrastructure

Agents

Logs

Diagnostics

Broker

Enrollment Server

Gateway

Guest

HALB Device

Provider

RDS

Application Packages

MSIX Image

Details

AVD

Custom Host

All

Gallery

Image

Host Pool

App Package Assigned

Assignment

Auto Upgrade

Messages

Create Hosts

Existing

Optimization

Registry

Windows Component

Windows Scheduled Task

Windows Service

Recreate Hosts

Schedule

Disable

Messages

Reboot

Shutdown

Startup

Target

Status

FSLogix

General

Office Container

CCD Locations

User Exclusion

User Inclusion

VHD Locations

Profile Container

CCD Locations

Folder Exclusion

Folder Inclusion

User Exclusion

User Inclusion

VHD Locations

Location

Offer

Predefined Images

Publisher

Settings

Template

Enter Maintenance

Windows Component

Get HALB Device

get

Retrieves the agent diagnostic information about an installed RAS HALB Device Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve HALB Device Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified HALB Device Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/HALBDevice HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = PortMismatch",
    "7 = Synchronising",
    "8 = TSDisabled",
    "9 = PreChecking",
    "10 = RebootPending",
    "11 = TSInstalling",
    "13 = Rebooting",
    "15 = LogonDrainUntilReboot",
    "16 = LogonDrain",
    "17 = LogonDisable",
    "18 = SchedRebootPending",
    "20 = StartCheckUDP",
    "22 = NotFound",
    "23 = FIPSModeFailed",
    "24 = FIPSModeUnsupported",
    "25 = FSLogixNotAvail",
    "26 = OSNotSupported",
    "27 = SchedShutdownPending",
    "28 = FailedPerfCounters",
    "256 = NotInstalled"
  ],
  "initialized": true,
  "ipAddress": "text",
  "logging": true,
  "macAddress": "text",
  "supported": true
}

Get Guest

get

Retrieves the agent diagnostic information about an installed RAS Guest Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve Guest Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Guest Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/Guest HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = PortMismatch",
    "7 = Synchronising",
    "8 = TSDisabled",
    "9 = PreChecking",
    "10 = RebootPending",
    "11 = TSInstalling",
    "13 = Rebooting",
    "15 = LogonDrainUntilReboot",
    "16 = LogonDrain",
    "17 = LogonDisable",
    "18 = SchedRebootPending",
    "20 = StartCheckUDP",
    "22 = NotFound",
    "23 = FIPSModeFailed",
    "24 = FIPSModeUnsupported",
    "25 = FSLogixNotAvail",
    "26 = OSNotSupported",
    "27 = SchedShutdownPending",
    "28 = FailedPerfCounters",
    "256 = NotInstalled"
  ],
  "dhcp": true,
  "protocolVersion": 1,
  "rdshMode": true,
  "terminalServicesInstalled": true
}

List

get

Retrieve application package(s).

Query parameters

siteIdinteger · int32Optional

ID of the SIte from which to retrieve the AppPackage setting.(optional).

NamestringOptional

Application package name (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AppPackage HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "packageName": "text",
    "displayName": "text",
    "version": "text",
    "publisher": "text",
    "msixImagePath": "text",
    "packagedApps": [
      {
        "name": "text"
      }
    ],
    "dependencies": "text",
    "certificate": {
      "status": [
        "0 = Valid",
        "1 = Expiring",
        "2 = Expired",
        "3 = InProgress",
        "4 = Revoked",
        "5 = Issuing",
        "6 = IssuingFailed",
        "7 = Renewing",
        "8 = RenewingFailed",
        "9 = Revoking",
        "10 = RevokingFailed"
      ],
      "publicKey": "text",
      "expirationDate": "2025-05-09T04:40:27.458Z",
      "keySize": [
        "0 = KeySize1024",
        "1 = KeySize2048",
        "2 = KeySize4096",
        "3 = KeySize3072",
        "4 = KeySize521",
        "255 = KeySizeUnknown"
      ],
      "commonName": "text"
    },
    "siteId": 1,
    "enabled": true,
    "tagIds": [
      1
    ]
  }
]

Get

get

Retrieve an application package by ID.

Path parameters

idinteger · int32Required

Application package ID.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "packageName": "text",
  "displayName": "text",
  "version": "text",
  "publisher": "text",
  "msixImagePath": "text",
  "packagedApps": [
    {
      "name": "text"
    }
  ],
  "dependencies": "text",
  "certificate": {
    "status": [
      "0 = Valid",
      "1 = Expiring",
      "2 = Expired",
      "3 = InProgress",
      "4 = Revoked",
      "5 = Issuing",
      "6 = IssuingFailed",
      "7 = Renewing",
      "8 = RenewingFailed",
      "9 = Revoking",
      "10 = RevokingFailed"
    ],
    "publicKey": "text",
    "expirationDate": "2025-05-09T04:40:27.458Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "siteId": 1,
  "enabled": true,
  "tagIds": [
    1
  ]
}

Delete

delete

Delete an application package.

Path parameters

idinteger · int32Required

Application package ID.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

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

No content

Get RDS

get

Retrieves the agent diagnostic information about an installed RAS RD Session Host Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve RD Session Host Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified RD Session Host Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/RDS HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "deInstalled": true,
  "wiaServiceEnabled": true,
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = PortMismatch",
    "7 = Synchronising",
    "8 = TSDisabled",
    "9 = PreChecking",
    "10 = RebootPending",
    "11 = TSInstalling",
    "13 = Rebooting",
    "15 = LogonDrainUntilReboot",
    "16 = LogonDrain",
    "17 = LogonDisable",
    "18 = SchedRebootPending",
    "20 = StartCheckUDP",
    "22 = NotFound",
    "23 = FIPSModeFailed",
    "24 = FIPSModeUnsupported",
    "25 = FSLogixNotAvail",
    "26 = OSNotSupported",
    "27 = SchedShutdownPending",
    "28 = FailedPerfCounters",
    "256 = NotInstalled"
  ],
  "connectedBrokerIP": "text",
  "logonStatus": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = DrainUntilReboot",
    "3 = Drain"
  ],
  "pendingReboot": true,
  "terminalServicesInstalled": true,
  "terminalServicesPort": 1,
  "updStatus": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = NotSupported",
    "3 = Unknown"
  ],
  "version": 1
}

List of Custom Hosts Not in Host Pools

get

Retrieve a list of Azure Virtual Desktop Custom Hosts not in Host Pools.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Custom Hosts.

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/CustomHost HTTP/1.1
Host: 
Accept: */*

[
  {
    "host": "text",
    "hostPool": "text",
    "hostOS": "text",
    "hostState": [
      "0 = Unknown",
      "1 = PoweringOn",
      "2 = PoweringOff",
      "3 = PoweredOn",
      "4 = PoweredOff"
    ],
    "resourceGroup": "text",
    "location": "text",
    "virtualNetwork": "text",
    "providerId": 1,
    "azureId": "text"
  }
]

Get

get

Retrieve RAS Agent Log(s).

Query parameters

serverstringOptional

RAS Agent Server name

siteIdinteger · int32Optional

Site ID of the specified server.

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:

Responses

200

Success

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/logs HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve RAS Agent(s) information.

Query parameters

siteIdinteger · int32Optional

Site ID for which to retrieve RAS Agent information.

serverTypestring · enumOptional

RAS Status Type

Possible values:

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "siteId": 1,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ]
  }
]

Get

get

Retrieve RAS Agent(s) information.

Path parameters

serverstringRequired

RAS Agent Server name

Query parameters

siteIdinteger · int32Optional

Site ID for which to retrieve RAS Agent information.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/{server} HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "siteId": 1,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ]
  }
]

Get Connection Broker

get

Retrieves the agent diagnostic information about an installed RAS Connection Broker.

Query parameters

ServerstringOptional

The name of server from which to retrieve Connection Broker information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Connection Broker information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/Broker HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = Connecting",
    "1 = Verified",
    "2 = NotVerified",
    "4 = InUse",
    "5 = CannotBeUsed",
    "6 = NeedUpdate",
    "8 = Disabled",
    "9 = NotFound",
    "10 = Standby",
    "11 = OSNotSupported"
  ],
  "canTakeover": true,
  "ip": "text",
  "primaryServer": "text"
}

Get Enrollment Server

get

Retrieves the agent diagnostic information about an installed RAS Enrollment Server Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve Enrollment Server Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Enrollment Server Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/EnrollmentServer HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = PortMismatch",
    "7 = Synchronising",
    "8 = TSDisabled",
    "9 = PreChecking",
    "10 = RebootPending",
    "11 = TSInstalling",
    "13 = Rebooting",
    "15 = LogonDrainUntilReboot",
    "16 = LogonDrain",
    "17 = LogonDisable",
    "18 = SchedRebootPending",
    "20 = StartCheckUDP",
    "22 = NotFound",
    "23 = FIPSModeFailed",
    "24 = FIPSModeUnsupported",
    "25 = FSLogixNotAvail",
    "26 = OSNotSupported",
    "27 = SchedShutdownPending",
    "28 = FailedPerfCounters",
    "256 = NotInstalled"
  ],
  "connectedBrokerIP": "text",
  "version": 1
}

List Details

get

Retrieve the list of package details from an image.

Query parameters

PathstringOptional

The MSIX image path (URL encoded in ASCII format).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/MSIXImage/Details HTTP/1.1
Host: 
Accept: */*

[
  {
    "packageName": "text",
    "displayName": "text",
    "version": "text",
    "publisher": "text",
    "msixImagePath": "text",
    "packagedApps": [
      {
        "name": "text"
      }
    ],
    "dependencies": "text",
    "certificate": {
      "status": [
        "0 = Valid",
        "1 = Expiring",
        "2 = Expired",
        "3 = InProgress",
        "4 = Revoked",
        "5 = Issuing",
        "6 = IssuingFailed",
        "7 = Renewing",
        "8 = RenewingFailed",
        "9 = Revoking",
        "10 = RevokingFailed"
      ],
      "publicKey": "text",
      "expirationDate": "2025-05-09T04:40:27.458Z",
      "keySize": [
        "0 = KeySize1024",
        "1 = KeySize2048",
        "2 = KeySize4096",
        "3 = KeySize3072",
        "4 = KeySize521",
        "255 = KeySizeUnknown"
      ],
      "commonName": "text"
    }
  }
]

List

get

Retrieve Assignment List of an AVD Host Pool with the specified ID.

Path parameters

idinteger · int32Required

The ID of an AVD Host Pool for which to retrieve the Assignment settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text",
    "azureActiveDirectory": "text",
    "azureActiveDirectoryId": "text"
  }
]

List of all Custom Hosts

get

Retrieve a list of all Azure Virtual Desktop Custom Hosts.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Custom Hosts.

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/CustomHost/All HTTP/1.1
Host: 
Accept: */*

[
  {
    "host": "text",
    "hostPool": "text",
    "hostOS": "text",
    "hostState": [
      "0 = Unknown",
      "1 = PoweringOn",
      "2 = PoweringOff",
      "3 = PoweredOn",
      "4 = PoweredOff"
    ],
    "resourceGroup": "text",
    "location": "text",
    "virtualNetwork": "text",
    "providerId": 1,
    "azureId": "text"
  }
]

Get

get

Retrieve the setting of the assigned application package.

Path parameters

idinteger · int32Required

Retrieve the assigned application package by ID.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

[
  {
    "version": "text",
    "tagName": "text",
    "tagId": 1,
    "packageName": "text"
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Host Pools.

Query parameters

namestringOptional

the Name of the Azure Virtual Desktop Host Pool

siteIdinteger · int32Optional

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

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/HostPool HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "enabled": true,
    "name": "text",
    "friendlyName": "text",
    "description": "text",
    "resourceGroup": "text",
    "location": "text",
    "azureId": "text",
    "workspaceId": 1,
    "linkedDesktopApplicationGroup": "text",
    "linkedRemoteApplicationGroup": "text",
    "configuration": {
      "poolType": [
        "0 = Pooled",
        "1 = Personal"
      ],
      "publishingType": [
        "0 = RemoteApp",
        "1 = Desktop"
      ],
      "provisioningType": [
        "0 = Template",
        "1 = Standalone"
      ],
      "loadBalancerType": [
        "0 = BreadthFirst",
        "1 = DepthFirst",
        "2 = Persistent"
      ],
      "powerOnHost": true,
      "validationEnvironment": true,
      "limitHosts": 1,
      "defaultLicenseType": [
        "0 = DoNotConfigure",
        "1 = WindowsClient",
        "2 = WindowsServer"
      ]
    },
    "provisioningSettings": {
      "hostName": "text",
      "defaultPowerState": [
        "0 = PoweredOn",
        "1 = PoweredOff",
        "2 = Suspended"
      ],
      "maxHosts": 1,
      "preCreatedHosts": 1,
      "duration": 1,
      "autoScale": {
        "templateId": 1,
        "templateVersionId": 1,
        "autoScaleEnabled": true,
        "minServersFromTemplate": 1,
        "maxServersFromTemplate": 1,
        "workloadThreshold": 1,
        "serversToAddPerRequest": 1,
        "workLoadDrain": 1,
        "drainRemainsBelowSec": 1,
        "removeServersAfterDrainAndPowerOff": true
      },
      "overwriteSize": true,
      "vmSize": {
        "vmSize": "text",
        "offering": "text",
        "family": "text",
        "vcpUs": 1,
        "ram": "text",
        "dataDisk": 1,
        "maximumIOPS": "text",
        "tempStorage": 1,
        "premiumDiskSupport": [
          "0 = No",
          "1 = Yes"
        ]
      }
    },
    "assignments": [
      {
        "account": "text",
        "type": [
          "1 = User",
          "2 = Group",
          "3 = ForeignSecurityPrincipal",
          "4 = Computer"
        ],
        "sid": "text",
        "azureActiveDirectory": "text",
        "azureActiveDirectoryId": "text"
      }
    ],
    "inheritDefaultAgentSettings": true,
    "agent": {
      "disconnectActiveSessionAfter": 1,
      "logoffDisconnectedSessionAfter": 1,
      "sessionReadinessTimeout": 1,
      "allowURLAndMailRedirection": [
        "0 = Disabled",
        "1 = Enabled",
        "2 = EnabledWithAppRegistration"
      ],
      "supportShellURLNamespaceObjects": true,
      "dragAndDropMode": [
        "0 = Disabled",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "allowRemoteExec": true,
      "manageRDPTransportProtocol": [
        "0 = Disabled",
        "1 = BothUDPTCP",
        "2 = OnlyTCP",
        "3 = EitherUDPTCP"
      ],
      "fileTransferMode": [
        "0 = Disabled",
        "1 = ClientToServer",
        "2 = ServerToClient",
        "3 = Bidirectional"
      ],
      "fileTransferLocation": "text",
      "fileTransferLockLocation": true,
      "enableDriveRedirectionCache": true,
      "manageRDPShortpath": true,
      "appMonitor": true,
      "useRDPShortpath": true,
      "useSmallerPortRange": true,
      "minRDPShortpathPort": 1,
      "maxRDPShortpathPort": 1
    },
    "inheritDefaultUserProfileSettings": true,
    "userProfile": {
      "technology": [
        "0 = DoNotManage",
        "1 = UPD",
        "2 = FSLogix"
      ],
      "fsLogix": {
        "profileContainer": {
          "enabled": true,
          "locationType": [
            "0 = SMBLocation",
            "1 = CloudCache"
          ],
          "vhdLocations": [
            "text"
          ],
          "ccdLocations": [
            "text"
          ],
          "profileDiskFormat": [
            "0 = VHD",
            "1 = VHDX"
          ],
          "allocationType": [
            "0 = Dynamic",
            "1 = Full"
          ],
          "defaultSize": 1,
          "userInclusionList": [
            {
              "account": "text",
              "type": [
                "1 = User",
                "2 = Group",
                "3 = ForeignSecurityPrincipal",
                "4 = Computer"
              ],
              "sid": "text"
            }
          ],
          "userExclusionList": [
            {
              "account": "text",
              "type": [
                "1 = User",
                "2 = Group",
                "3 = ForeignSecurityPrincipal",
                "4 = Computer"
              ],
              "sid": "text"
            }
          ],
          "cloudCache": {
            "useMaxCacheSizeInMBs": true,
            "maxCacheSizeInMBs": 1,
            "useClearCacheOnLogoff": true,
            "clearCacheOnLogoff": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useHealthyProvidersRequiredForRegister": true,
            "healthyProvidersRequiredForRegister": 1,
            "useHealthyProvidersRequiredForUnregister": true,
            "healthyProvidersRequiredForUnregister": 1,
            "useUnregisterTimeout": true,
            "unregisterTimeout": 1,
            "useClearCacheOnForcedUnregister": true,
            "clearCacheOnForcedUnregister": [
              "0 = Disable",
              "1 = Enable"
            ]
          },
          "customizeProfileFolders": true,
          "excludeCommonFolders": [
            "1 = Contacts",
            "2 = Desktop",
            "4 = Documents",
            "8 = Links",
            "16 = MusicPodcasts",
            "32 = PicturesVideos",
            "64 = FoldersLowIntegProcesses",
            "128 = Downloads"
          ],
          "folderInclusionList": [
            "text"
          ],
          "folderExclusionList": [
            {
              "folder": "text",
              "excludeFolderCopy": [
                "0 = None",
                "1 = CopyBase",
                "2 = CopyBack"
              ]
            }
          ],
          "advancedSettings": {
            "useLockedRetryCount": true,
            "lockedRetryCount": 1,
            "useLockedRetryInterval": true,
            "lockedRetryInterval": 1,
            "useAccessNetworkAsComputerObject": true,
            "accessNetworkAsComputerObject": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useAttachVHDSDDL": true,
            "attachVHDSDDL": "text",
            "useDiffDiskParentFolderPath": true,
            "diffDiskParentFolderPath": "text",
            "useFlipFlopProfileDirectoryName": true,
            "flipFlopProfileDirectoryName": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useNoProfileContainingFolder": true,
            "noProfileContainingFolder": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useOutlookCachedMode": true,
            "outlookCachedMode": [
              "0 = Disable",
              "1 = Enable"
            ],
            "usePreventLoginWithFailure": true,
            "preventLoginWithFailure": [
              "0 = Disable",
              "1 = Enable"
            ],
            "usePreventLoginWithTempProfile": true,
            "preventLoginWithTempProfile": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useReAttachRetryCount": true,
            "reAttachRetryCount": 1,
            "useReAttachIntervalSeconds": true,
            "reAttachIntervalSeconds": 1,
            "useRemoveOrphanedOSTFilesOnLogoff": true,
            "removeOrphanedOSTFilesOnLogoff": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useRoamSearch": true,
            "roamSearch": [
              "0 = Disable",
              "1 = SingleUser",
              "2 = MultiUser"
            ],
            "useSIDDirNameMatch": true,
            "sidDirNameMatch": "text",
            "useSIDDirNamePattern": true,
            "sidDirNamePattern": "text",
            "useSIDDirSDDL": true,
            "sidDirSDDL": "text",
            "useVHDNameMatch": true,
            "vhdNameMatch": "text",
            "useVHDNamePattern": true,
            "vhdNamePattern": "text",
            "useVHDXSectorSize": true,
            "vhdxSectorSize": [
              "0 = SystemDefault",
              "512 = Size_512",
              "4096 = Size_4096"
            ],
            "useVolumeWaitTimeMS": true,
            "volumeWaitTimeMS": 1,
            "useIgnoreNonAVD": true,
            "ignoreNonAVD": [
              "0 = AnySession",
              "1 = AVDSessions"
            ],
            "useRedirectType": true,
            "redirectType": [
              "1 = Legacy",
              "2 = Advanced"
            ],
            "useKeepLocalDir": true,
            "keepLocalDir": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useDeleteLocalProfileWhenVHDShouldApply": true,
            "deleteLocalProfileWhenVHDShouldApply": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useProfileDirSDDL": true,
            "profileDirSDDL": "text",
            "useProfileType": true,
            "profileType": [
              "0 = NormalProfile",
              "1 = OnlyRWProfile",
              "2 = OnlyROProfile",
              "3 = RWROProfile"
            ],
            "useSetTempToLocalPath": true,
            "setTempToLocalPath": [
              "0 = TakeNoAction",
              "1 = RedirectTempAndTmp",
              "2 = RedirectINetCache",
              "3 = RedirectTempTmpAndINetCache"
            ],
            "useCleanOutNotifications": true,
            "cleanOutNotifications": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useInstallAppxPackages": true,
            "installAppxPackages": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useRebootOnUserLogoff": true,
            "rebootOnUserLogoff": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useRoamIdentity": true,
            "roamIdentity": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useShutdownOnUserLogoff": true,
            "shutdownOnUserLogoff": [
              "0 = Disable",
              "1 = Enable"
            ]
          }
        },
        "officeContainer": {
          "enabled": true,
          "locationType": [
            "0 = SMBLocation",
            "1 = CloudCache"
          ],
          "vhdLocations": [
            "text"
          ],
          "ccdLocations": [
            "text"
          ],
          "profileDiskFormat": [
            "0 = VHD",
            "1 = VHDX"
          ],
          "allocationType": [
            "0 = Dynamic",
            "1 = Full"
          ],
          "defaultSize": 1,
          "userInclusionList": [
            {
              "account": "text",
              "type": [
                "1 = User",
                "2 = Group",
                "3 = ForeignSecurityPrincipal",
                "4 = Computer"
              ],
              "sid": "text"
            }
          ],
          "userExclusionList": [
            {
              "account": "text",
              "type": [
                "1 = User",
                "2 = Group",
                "3 = ForeignSecurityPrincipal",
                "4 = Computer"
              ],
              "sid": "text"
            }
          ],
          "cloudCache": {
            "useMaxCacheSizeInMBs": true,
            "maxCacheSizeInMBs": 1,
            "useClearCacheOnLogoff": true,
            "clearCacheOnLogoff": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useHealthyProvidersRequiredForRegister": true,
            "healthyProvidersRequiredForRegister": 1,
            "useHealthyProvidersRequiredForUnregister": true,
            "healthyProvidersRequiredForUnregister": 1,
            "useUnregisterTimeout": true,
            "unregisterTimeout": 1,
            "useClearCacheOnForcedUnregister": true,
            "clearCacheOnForcedUnregister": [
              "0 = Disable",
              "1 = Enable"
            ]
          },
          "advancedSettings": {
            "useLockedRetryCount": true,
            "lockedRetryCount": 1,
            "useLockedRetryInterval": true,
            "lockedRetryInterval": 1,
            "useAccessNetworkAsComputerObject": true,
            "accessNetworkAsComputerObject": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useAttachVHDSDDL": true,
            "attachVHDSDDL": "text",
            "useDiffDiskParentFolderPath": true,
            "diffDiskParentFolderPath": "text",
            "useFlipFlopProfileDirectoryName": true,
            "flipFlopProfileDirectoryName": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useNoProfileContainingFolder": true,
            "noProfileContainingFolder": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useOutlookCachedMode": true,
            "outlookCachedMode": [
              "0 = Disable",
              "1 = Enable"
            ],
            "usePreventLoginWithFailure": true,
            "preventLoginWithFailure": [
              "0 = Disable",
              "1 = Enable"
            ],
            "usePreventLoginWithTempProfile": true,
            "preventLoginWithTempProfile": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useReAttachRetryCount": true,
            "reAttachRetryCount": 1,
            "useReAttachIntervalSeconds": true,
            "reAttachIntervalSeconds": 1,
            "useRemoveOrphanedOSTFilesOnLogoff": true,
            "removeOrphanedOSTFilesOnLogoff": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useRoamSearch": true,
            "roamSearch": [
              "0 = Disable",
              "1 = SingleUser",
              "2 = MultiUser"
            ],
            "useSIDDirNameMatch": true,
            "sidDirNameMatch": "text",
            "useSIDDirNamePattern": true,
            "sidDirNamePattern": "text",
            "useSIDDirSDDL": true,
            "sidDirSDDL": "text",
            "useVHDNameMatch": true,
            "vhdNameMatch": "text",
            "useVHDNamePattern": true,
            "vhdNamePattern": "text",
            "useVHDXSectorSize": true,
            "vhdxSectorSize": [
              "0 = SystemDefault",
              "512 = Size_512",
              "4096 = Size_4096"
            ],
            "useVolumeWaitTimeMS": true,
            "volumeWaitTimeMS": 1,
            "useIgnoreNonAVD": true,
            "ignoreNonAVD": [
              "0 = AnySession",
              "1 = AVDSessions"
            ],
            "useRedirectType": true,
            "redirectType": [
              "1 = Legacy",
              "2 = Advanced"
            ],
            "useIncludeOfficeActivation": true,
            "includeOfficeActivation": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeOneDrive": true,
            "includeOneDrive": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeOneNote": true,
            "includeOneNote": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeOneNoteUWP": true,
            "includeOneNoteUWP": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeOutlook": true,
            "includeOutlook": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeOutlookPersonalization": true,
            "includeOutlookPersonalization": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeSharepoint": true,
            "includeSharepoint": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeSkype": true,
            "includeSkype": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useIncludeTeams": true,
            "includeTeams": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useMirrorLocalOSTToVHD": true,
            "mirrorLocalOSTToVHD": [
              "0 = DoNothing",
              "1 = Copy",
              "2 = Move"
            ],
            "useNumSessionVHDsToKeep": true,
            "numSessionVHDsToKeep": 1,
            "useOutlookFolderPath": true,
            "outlookFolderPath": "text",
            "useRefreshUserPolicy": true,
            "refreshUserPolicy": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useVHDAccessMode": true,
            "vhdAccessMode": [
              "0 = NormalDirectAccess",
              "1 = DiffDiskNetwork",
              "2 = DiffDiskLocal",
              "3 = UniqueVHDPerSession"
            ]
          }
        },
        "generalSettings": {
          "appServices": {
            "useCleanupInvalidSessions": true,
            "cleanupInvalidSessions": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useRoamRecycleBin": true,
            "roamRecycleBin": [
              "0 = Disable",
              "1 = Enable"
            ],
            "useVHDCompactDisk": true,
            "vhdCompactDisk": [
              "0 = Disable",
              "1 = Enable"
            ]
          },
          "cloudCacheGeneral": {
            "useCacheDirectory": true,
            "cacheDirectory": "text",
            "useWriteCacheDirectory": true,
            "writeCacheDirectory": "text",
            "useProxyDirectory": true,
            "proxyDirectory": "text",
            "useSilenceACLWarning": true,
            "silenceACLWarning": [
              "0 = Disable",
              "1 = Enable"
            ]
          },
          "logging": {
            "logEnabled": [
              "0 = Disable",
              "1 = Specific",
              "2 = All"
            ],
            "logLevel": [
              "0 = Debug",
              "1 = Information",
              "2 = Warning",
              "3 = Error"
            ],
            "logFileKeepingPeriod": 1,
            "logDirectory": "text",
            "robocopyLogPath": "text",
            "logSpecificComponents": [
              "1 = ProfileConfigTool",
              "2 = IEPlugin",
              "4 = RuleEditor",
              "8 = JavaRuleEditor",
              "16 = FSLogixAgentService",
              "32 = Profile",
              "64 = JavaLauncher",
              "128 = OfficeContainer",
              "256 = RuleCompilation",
              "512 = FontVisibility",
              "1024 = Network",
              "2048 = PrinterVisibility",
              "4096 = ADSComputerGroup",
              "8192 = DriverInterface",
              "16384 = WindowsSearchRoaming",
              "32768 = WindowsSearchPlugin",
              "65536 = ProcessStartMonitor"
            ]
          }
        }
      }
    },
    "inheritDefaultAppPackageSettings": true,
    "appPackagesAssigned": {
      "applicationPackagesAssigned": [
        {
          "version": "text",
          "tagName": "text",
          "tagId": 1,
          "packageName": "text"
        }
      ]
    },
    "inheritDefaultOptimizationSettings": true,
    "optimization": {
      "enableOptimization": true,
      "optimizationType": [
        "0 = Automatic",
        "1 = Manual"
      ],
      "windowsDefenderATP": {
        "winDefATPTurnOffOn": [
          "0 = TurnOffWindowsDefenderATP",
          "1 = TurnOnWindowsDefenderATP"
        ],
        "disableRealTimeProtection": true,
        "excludeFolders": [
          "text"
        ],
        "excludeProcesses": [
          "text"
        ],
        "excludeExtension": [
          "text"
        ]
      },
      "windowsComponents": {
        "windowsComponentsList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "componentName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsDefenderATPEnabled": true,
      "windowsComponentsEnabled": true,
      "windowsServicesEnabled": true,
      "windowsScheduledTasksEnabled": true,
      "windowsAdvancedOptionsEnabled": true,
      "networkPerformanceEnabled": true,
      "registryEnabled": true,
      "visualEffectsEnabled": true,
      "diskCleanupEnabled": true,
      "customScriptEnabled": true,
      "windowsServices": {
        "windowsServicesList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "serviceName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsAdvancedOptions": {
        "partialStartLayoutContent": "text",
        "hibernate": true,
        "teleCollection": true,
        "systemRestore": true,
        "additionalErrorReport": true,
        "tiles": true,
        "cortana": true,
        "microsoftConsumerExperience": true,
        "windowsTips": true,
        "commonProgramGroups": true,
        "partialStartMenu": true
      },
      "networkPerformance": {
        "dirCacheMax": 1,
        "dormantFileLimit": 1,
        "fileNotFoundCache": 1,
        "fileInfoCache": 1,
        "fileInfoCacheEnable": true,
        "directoryCacheEnable": true,
        "fileNotFoundCacheEnable": true,
        "dormantFileLimitEnable": true,
        "disableTCP": true,
        "disableIPv6CompEnable": true,
        "disableIPv6ToIPv4": true,
        "disableIsaTap": true
      },
      "customScript": {
        "arguments": "text",
        "command": "text",
        "initDir": "text",
        "user": "text"
      },
      "diskCleanup": {
        "cleanupWinSxSFolder": true,
        "cleanupSystemFiles": true,
        "cleanupTemporaryFileLogs": true,
        "removeOneDrive": true,
        "deleteUserProfiles": true
      },
      "visualEffects": {
        "visualEffectsTypes": [
          "0 = LetWindowsChooseWhatsBest",
          "1 = AdjustForBestAppearance",
          "2 = AdjustForBestPerformance",
          "3 = Custom"
        ],
        "animateControlSelectElements": true,
        "animateWindowsWhenMinimizingMaximizing": true,
        "animateTaskbar": true,
        "enablePeek": true,
        "fadeSlideMenus": true,
        "fadeSlideToolTips": true,
        "fadeOutMenuItems": true,
        "saveTaskbarThumbnail": true,
        "showShadowUnderMouse": true,
        "shadowUnderWindows": true,
        "thumbnailsInsteadOfIcons": true,
        "showTranslucentSelection": true,
        "showWindowsContentWhilstDragging": true,
        "slideOpenComboBoxes": true,
        "smoothEdgesScreenFonts": true,
        "smoothScrollListBoxes": true,
        "dropShadowsIcon": true
      },
      "windowsScheduledTasks": {
        "windowsScheduledTasksList": [
          {
            "task": "text",
            "location": "text",
            "type": [
              "0 = Folder",
              "1 = Task"
            ]
          }
        ]
      },
      "registry": {
        "registryList": [
          {
            "id": 1,
            "action": [
              "0 = Add",
              "1 = Modify",
              "2 = Delete"
            ],
            "registryName": "text",
            "dwordValue": 1,
            "displayName": "text",
            "hiveType": [
              "0 = HKEY_CURRENT_CONFIG",
              "1 = HKEY_USERS",
              "2 = HKEY_LOCAL_MACHINE",
              "3 = HKEY_CLASSES_ROOT"
            ],
            "path": "text",
            "regType": [
              "0 = REG_SZ",
              "1 = REG_DWORD",
              "2 = REG_QWORD",
              "3 = REG_MULTI_SZ",
              "4 = REG_EXPAND_SZ"
            ],
            "stringValue": "text"
          }
        ]
      },
      "uwpApps": {
        "allExcept": [
          "text"
        ],
        "followingPkgs": [
          "text"
        ],
        "removeType": [
          "0 = AllExcept",
          "1 = FollowingPkgs"
        ]
      }
    },
    "inheritDefaultActionsSettings": true,
    "action": {
      "sessionAction": [
        "0 = Disconnect",
        "1 = Logoff"
      ],
      "performAction": [
        "0 = DoNothing",
        "2 = Shutdown",
        "4 = Suspend",
        "7 = Delete",
        "8 = Restart",
        "9 = Unassign",
        "10 = Recreate"
      ],
      "performActionAfterSec": 1
    },
    "inheritDefaultRDPPrinterSettings": true,
    "rdpPrinter": {
      "printerNameFormat": [
        "0 = PrnFormat_PRN_CMP_SES",
        "1 = PrnFormat_SES_CMP_PRN",
        "2 = PrnFormat_PRN_REDSES"
      ],
      "removeSessionNumberFromPrinterName": true,
      "removeClientNameFromPrinterName": true
    },
    "inheritDefaultAutoUpgradeSettings": true,
    "autoUpgrade": {
      "enabled": true,
      "startDateTime": "2025-05-09T04:40:27.458Z",
      "drainModeDurationInSecs": 1,
      "forceLogoffSessions": true,
      "repeat": [
        "0 = Never",
        "1 = EveryDay",
        "2 = EveryWeek",
        "3 = Every2Weeks",
        "4 = EveryMonth",
        "5 = EveryYear",
        "6 = SpecificDays"
      ],
      "specificDays": [
        "0 = Never",
        "1 = Sunday",
        "2 = Monday",
        "4 = Tuesday",
        "8 = Wednesday",
        "16 = Thursday",
        "32 = Friday",
        "64 = Saturday"
      ],
      "messages": [
        {
          "id": 1,
          "enabled": true,
          "messageTitle": "text",
          "message": "text",
          "sendMsgSecs": 1,
          "sendMsgWhen": [
            "0 = Before",
            "1 = After"
          ]
        }
      ]
    }
  }
]

Get

get

Retrieve the Azure Virtual Desktop Host Pool.

Path parameters

idinteger · int32Required

The ID of the Azure Virtual Desktop Host Pool.

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/HostPool/{id} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "enabled": true,
  "name": "text",
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text",
  "workspaceId": 1,
  "linkedDesktopApplicationGroup": "text",
  "linkedRemoteApplicationGroup": "text",
  "configuration": {
    "poolType": [
      "0 = Pooled",
      "1 = Personal"
    ],
    "publishingType": [
      "0 = RemoteApp",
      "1 = Desktop"
    ],
    "provisioningType": [
      "0 = Template",
      "1 = Standalone"
    ],
    "loadBalancerType": [
      "0 = BreadthFirst",
      "1 = DepthFirst",
      "2 = Persistent"
    ],
    "powerOnHost": true,
    "validationEnvironment": true,
    "limitHosts": 1,
    "defaultLicenseType": [
      "0 = DoNotConfigure",
      "1 = WindowsClient",
      "2 = WindowsServer"
    ]
  },
  "provisioningSettings": {
    "hostName": "text",
    "defaultPowerState": [
      "0 = PoweredOn",
      "1 = PoweredOff",
      "2 = Suspended"
    ],
    "maxHosts": 1,
    "preCreatedHosts": 1,
    "duration": 1,
    "autoScale": {
      "templateId": 1,
      "templateVersionId": 1,
      "autoScaleEnabled": true,
      "minServersFromTemplate": 1,
      "maxServersFromTemplate": 1,
      "workloadThreshold": 1,
      "serversToAddPerRequest": 1,
      "workLoadDrain": 1,
      "drainRemainsBelowSec": 1,
      "removeServersAfterDrainAndPowerOff": true
    },
    "overwriteSize": true,
    "vmSize": {
      "vmSize": "text",
      "offering": "text",
      "family": "text",
      "vcpUs": 1,
      "ram": "text",
      "dataDisk": 1,
      "maximumIOPS": "text",
      "tempStorage": 1,
      "premiumDiskSupport": [
        "0 = No",
        "1 = Yes"
      ]
    }
  },
  "assignments": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text",
      "azureActiveDirectory": "text",
      "azureActiveDirectoryId": "text"
    }
  ],
  "inheritDefaultAgentSettings": true,
  "agent": {
    "disconnectActiveSessionAfter": 1,
    "logoffDisconnectedSessionAfter": 1,
    "sessionReadinessTimeout": 1,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": true,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowRemoteExec": true,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": true,
    "enableDriveRedirectionCache": true,
    "manageRDPShortpath": true,
    "appMonitor": true,
    "useRDPShortpath": true,
    "useSmallerPortRange": true,
    "minRDPShortpathPort": 1,
    "maxRDPShortpathPort": 1
  },
  "inheritDefaultUserProfileSettings": true,
  "userProfile": {
    "technology": [
      "0 = DoNotManage",
      "1 = UPD",
      "2 = FSLogix"
    ],
    "fsLogix": {
      "profileContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "customizeProfileFolders": true,
        "excludeCommonFolders": [
          "1 = Contacts",
          "2 = Desktop",
          "4 = Documents",
          "8 = Links",
          "16 = MusicPodcasts",
          "32 = PicturesVideos",
          "64 = FoldersLowIntegProcesses",
          "128 = Downloads"
        ],
        "folderInclusionList": [
          "text"
        ],
        "folderExclusionList": [
          {
            "folder": "text",
            "excludeFolderCopy": [
              "0 = None",
              "1 = CopyBase",
              "2 = CopyBack"
            ]
          }
        ],
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useKeepLocalDir": true,
          "keepLocalDir": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useDeleteLocalProfileWhenVHDShouldApply": true,
          "deleteLocalProfileWhenVHDShouldApply": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useProfileDirSDDL": true,
          "profileDirSDDL": "text",
          "useProfileType": true,
          "profileType": [
            "0 = NormalProfile",
            "1 = OnlyRWProfile",
            "2 = OnlyROProfile",
            "3 = RWROProfile"
          ],
          "useSetTempToLocalPath": true,
          "setTempToLocalPath": [
            "0 = TakeNoAction",
            "1 = RedirectTempAndTmp",
            "2 = RedirectINetCache",
            "3 = RedirectTempTmpAndINetCache"
          ],
          "useCleanOutNotifications": true,
          "cleanOutNotifications": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useInstallAppxPackages": true,
          "installAppxPackages": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRebootOnUserLogoff": true,
          "rebootOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamIdentity": true,
          "roamIdentity": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useShutdownOnUserLogoff": true,
          "shutdownOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ]
        }
      },
      "officeContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useIncludeOfficeActivation": true,
          "includeOfficeActivation": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneDrive": true,
          "includeOneDrive": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNote": true,
          "includeOneNote": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNoteUWP": true,
          "includeOneNoteUWP": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlook": true,
          "includeOutlook": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlookPersonalization": true,
          "includeOutlookPersonalization": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSharepoint": true,
          "includeSharepoint": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSkype": true,
          "includeSkype": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeTeams": true,
          "includeTeams": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useMirrorLocalOSTToVHD": true,
          "mirrorLocalOSTToVHD": [
            "0 = DoNothing",
            "1 = Copy",
            "2 = Move"
          ],
          "useNumSessionVHDsToKeep": true,
          "numSessionVHDsToKeep": 1,
          "useOutlookFolderPath": true,
          "outlookFolderPath": "text",
          "useRefreshUserPolicy": true,
          "refreshUserPolicy": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDAccessMode": true,
          "vhdAccessMode": [
            "0 = NormalDirectAccess",
            "1 = DiffDiskNetwork",
            "2 = DiffDiskLocal",
            "3 = UniqueVHDPerSession"
          ]
        }
      },
      "generalSettings": {
        "appServices": {
          "useCleanupInvalidSessions": true,
          "cleanupInvalidSessions": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamRecycleBin": true,
          "roamRecycleBin": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDCompactDisk": true,
          "vhdCompactDisk": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "cloudCacheGeneral": {
          "useCacheDirectory": true,
          "cacheDirectory": "text",
          "useWriteCacheDirectory": true,
          "writeCacheDirectory": "text",
          "useProxyDirectory": true,
          "proxyDirectory": "text",
          "useSilenceACLWarning": true,
          "silenceACLWarning": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "logging": {
          "logEnabled": [
            "0 = Disable",
            "1 = Specific",
            "2 = All"
          ],
          "logLevel": [
            "0 = Debug",
            "1 = Information",
            "2 = Warning",
            "3 = Error"
          ],
          "logFileKeepingPeriod": 1,
          "logDirectory": "text",
          "robocopyLogPath": "text",
          "logSpecificComponents": [
            "1 = ProfileConfigTool",
            "2 = IEPlugin",
            "4 = RuleEditor",
            "8 = JavaRuleEditor",
            "16 = FSLogixAgentService",
            "32 = Profile",
            "64 = JavaLauncher",
            "128 = OfficeContainer",
            "256 = RuleCompilation",
            "512 = FontVisibility",
            "1024 = Network",
            "2048 = PrinterVisibility",
            "4096 = ADSComputerGroup",
            "8192 = DriverInterface",
            "16384 = WindowsSearchRoaming",
            "32768 = WindowsSearchPlugin",
            "65536 = ProcessStartMonitor"
          ]
        }
      }
    }
  },
  "inheritDefaultAppPackageSettings": true,
  "appPackagesAssigned": {
    "applicationPackagesAssigned": [
      {
        "version": "text",
        "tagName": "text",
        "tagId": 1,
        "packageName": "text"
      }
    ]
  },
  "inheritDefaultOptimizationSettings": true,
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "inheritDefaultActionsSettings": true,
  "action": {
    "sessionAction": [
      "0 = Disconnect",
      "1 = Logoff"
    ],
    "performAction": [
      "0 = DoNothing",
      "2 = Shutdown",
      "4 = Suspend",
      "7 = Delete",
      "8 = Restart",
      "9 = Unassign",
      "10 = Recreate"
    ],
    "performActionAfterSec": 1
  },
  "inheritDefaultRDPPrinterSettings": true,
  "rdpPrinter": {
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeSessionNumberFromPrinterName": true,
    "removeClientNameFromPrinterName": true
  },
  "inheritDefaultAutoUpgradeSettings": true,
  "autoUpgrade": {
    "enabled": true,
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "drainModeDurationInSecs": 1,
    "forceLogoffSessions": true,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ]
  }
}

Remove

delete

Removes an Azure Virtual Desktop Host Pool.

Path parameters

idinteger · int32Required

The ID of the Azure Virtual Desktop Host Pool 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/HostPool/{id} HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve a list of Azure Virtual Desktop Galleries.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Galleries.

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/Gallery HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "resourceGroup": "text",
    "azureId": "text"
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Gallery Images.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Gallery Images.

namestringOptional

The Name of the Azure Virtual Desktop Gallery from which to retieve the Azure Virtual Desktop Gallery Images.

resourceGroupstringOptional

The Resource Group of the Azure Virtual Desktop Gallery from which to retrieve the list of Azure Virtual Desktop Gallery Images.

locationstringOptional

The Location of the Azure Virtual Desktop Gallery from which to retrieve the list of Azure Virtual Desktop Gallery Images.

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/Gallery/Image HTTP/1.1
Host: 
Accept: */*

[
  {
    "image": "text",
    "version": "text",
    "publisher": "text"
  }
]

Get

get

Retrieve Image Optimization Settings

Path parameters

idinteger · int32Required

Retrieve the Image Optimization by id

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATP": {
    "winDefATPTurnOffOn": [
      "0 = TurnOffWindowsDefenderATP",
      "1 = TurnOnWindowsDefenderATP"
    ],
    "disableRealTimeProtection": true,
    "excludeFolders": [
      "text"
    ],
    "excludeProcesses": [
      "text"
    ],
    "excludeExtension": [
      "text"
    ]
  },
  "windowsComponents": {
    "windowsComponentsList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "componentName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "windowsServices": {
    "windowsServicesList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "serviceName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsAdvancedOptions": {
    "partialStartLayoutContent": "text",
    "hibernate": true,
    "teleCollection": true,
    "systemRestore": true,
    "additionalErrorReport": true,
    "tiles": true,
    "cortana": true,
    "microsoftConsumerExperience": true,
    "windowsTips": true,
    "commonProgramGroups": true,
    "partialStartMenu": true
  },
  "networkPerformance": {
    "dirCacheMax": 1,
    "dormantFileLimit": 1,
    "fileNotFoundCache": 1,
    "fileInfoCache": 1,
    "fileInfoCacheEnable": true,
    "directoryCacheEnable": true,
    "fileNotFoundCacheEnable": true,
    "dormantFileLimitEnable": true,
    "disableTCP": true,
    "disableIPv6CompEnable": true,
    "disableIPv6ToIPv4": true,
    "disableIsaTap": true
  },
  "customScript": {
    "arguments": "text",
    "command": "text",
    "initDir": "text",
    "user": "text"
  },
  "diskCleanup": {
    "cleanupWinSxSFolder": true,
    "cleanupSystemFiles": true,
    "cleanupTemporaryFileLogs": true,
    "removeOneDrive": true,
    "deleteUserProfiles": true
  },
  "visualEffects": {
    "visualEffectsTypes": [
      "0 = LetWindowsChooseWhatsBest",
      "1 = AdjustForBestAppearance",
      "2 = AdjustForBestPerformance",
      "3 = Custom"
    ],
    "animateControlSelectElements": true,
    "animateWindowsWhenMinimizingMaximizing": true,
    "animateTaskbar": true,
    "enablePeek": true,
    "fadeSlideMenus": true,
    "fadeSlideToolTips": true,
    "fadeOutMenuItems": true,
    "saveTaskbarThumbnail": true,
    "showShadowUnderMouse": true,
    "shadowUnderWindows": true,
    "thumbnailsInsteadOfIcons": true,
    "showTranslucentSelection": true,
    "showWindowsContentWhilstDragging": true,
    "slideOpenComboBoxes": true,
    "smoothEdgesScreenFonts": true,
    "smoothScrollListBoxes": true,
    "dropShadowsIcon": true
  },
  "windowsScheduledTasks": {
    "windowsScheduledTasksList": [
      {
        "task": "text",
        "location": "text",
        "type": [
          "0 = Folder",
          "1 = Task"
        ]
      }
    ]
  },
  "registry": {
    "registryList": [
      {
        "id": 1,
        "action": [
          "0 = Add",
          "1 = Modify",
          "2 = Delete"
        ],
        "registryName": "text",
        "dwordValue": 1,
        "displayName": "text",
        "hiveType": [
          "0 = HKEY_CURRENT_CONFIG",
          "1 = HKEY_USERS",
          "2 = HKEY_LOCAL_MACHINE",
          "3 = HKEY_CLASSES_ROOT"
        ],
        "path": "text",
        "regType": [
          "0 = REG_SZ",
          "1 = REG_DWORD",
          "2 = REG_QWORD",
          "3 = REG_MULTI_SZ",
          "4 = REG_EXPAND_SZ"
        ],
        "stringValue": "text"
      }
    ]
  },
  "uwpApps": {
    "allExcept": [
      "text"
    ],
    "followingPkgs": [
      "text"
    ],
    "removeType": [
      "0 = AllExcept",
      "1 = FollowingPkgs"
    ]
  }
}

List

get

Retrieve Auto-upgrade Message(s).

Path parameters

idinteger · int32Required

The ID of the Auto-upgrade setting for which to retrieve the messages.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/AutoUpgrade/Messages HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }
]

Get

get

Retrieve an Auto-upgrade Message.

Path parameters

idinteger · int32Required

The ID of the Auto-upgrade setting for which to retrieve the message.

messageIdinteger · int32Required

The ID of the message to retrieve.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Delete

delete

Delete an Auto-upgrade Message by ID.

Path parameters

idinteger · int32Required

The ID of the Auto-upgrade setting for which to remove the message.

messageIdinteger · int32Required

The ID of the message to remove.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

No content

Create Hosts

post

Create Hosts

Path parameters

idinteger · int32Required

The ID of the target RAS HostPool.

Query parameters

noOfHostsToCreateinteger · int32Optional

The number of Hosts to create from the specified RAS HostPool. Default: 1.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/CreateHosts HTTP/1.1
Host: 
Accept: */*

No content

Get

get

Retrieve the Auto-upgrade settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the Auto-upgrade settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "enabled": true,
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "drainModeDurationInSecs": 1,
  "forceLogoffSessions": true,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "messages": [
    {
      "id": 1,
      "enabled": true,
      "messageTitle": "text",
      "message": "text",
      "sendMsgSecs": 1,
      "sendMsgWhen": [
        "0 = Before",
        "1 = After"
      ]
    }
  ]
}

List

get

Retrieve Windows Component Custom

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the windows component custom list.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/Optimization/WindowsComponent HTTP/1.1
Host: 
Accept: */*

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "componentName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Recreate Hosts

post

Recreate Hosts

Path parameters

idinteger · int32Required

The ID of the target RAS HostPool.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/RecreateHosts HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieves Registry.

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the registry.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/Optimization/Registry HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }
]

Get Gateway

get

Retrieves the agent diagnostic information about an installed RAS Gateway Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve RAS Secure Gateway Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified RAS SecureGateway Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/Gateway HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = PortMismatch",
    "7 = Synchronising",
    "8 = TSDisabled",
    "9 = PreChecking",
    "10 = RebootPending",
    "11 = TSInstalling",
    "13 = Rebooting",
    "15 = LogonDrainUntilReboot",
    "16 = LogonDrain",
    "17 = LogonDisable",
    "18 = SchedRebootPending",
    "20 = StartCheckUDP",
    "22 = NotFound",
    "23 = FIPSModeFailed",
    "24 = FIPSModeUnsupported",
    "25 = FSLogixNotAvail",
    "26 = OSNotSupported",
    "27 = SchedShutdownPending",
    "28 = FailedPerfCounters",
    "256 = NotInstalled"
  ],
  "extendedInfo": "text",
  "fipsMode": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = Failed",
    "3 = Unsupported"
  ],
  "iPs": [
    "text"
  ]
}

Get Provider

get

Retrieves the agent diagnostic information about an installed RAS Provider Agent.

Query parameters

ServerstringOptional

The name of server from which to retrieve Provider Agent information. This must be the actual server name used in the RAS farm.

SiteIdinteger · int32Optional

Site ID from which to retrieve the specified Provider Agent information (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/Agent/Diagnostic/Provider HTTP/1.1
Host: 
Accept: */*

{
  "server": "text",
  "agentDiagnosticType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = Broker",
    "25 = HALBDevice",
    "46 = EnrollmentServer"
  ],
  "agentVersion": "text",
  "osVersion": "text",
  "state": [
    "0 = StartCheck",
    "1 = NotVerified",
    "2 = Pending",
    "3 = Error",
    "4 = OK",
    "5 = NeedsUpdate",
    "6 = CheckCredentials",
    "7 = InvalidCredentials",
    "8 = CannotConnectToVDIAgent",
    "11 = UnsupportedVDI",
    "12 = VDITypeCheck",
    "16 = FreeESXLicenseNotSupported",
    "17 = ManagedESXNotSupported",
    "20 = StartCheckUDP",
    "22 = InvalidProviderVersion",
    "25 = SettingsNotApplied",
    "26 = InvalidVDIType",
    "27 = UnsupportedOS"
  ],
  "connectedBrokerIP": "text",
  "providerPort": 1,
  "version": 1
}

Create

post

Create a new application package.

Body

To create a new Application Package

displayNamestring | nullableOptional

Display name of the new application package.

packageNamestring | nullableRequired

Package name of the new application package.

msixImagePathstring | nullableRequired

MSIX image path of the new application package.

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AppPackage HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 66

{
  "displayName": "text",
  "packageName": "text",
  "msixImagePath": "text"
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "packageName": "text",
  "displayName": "text",
  "version": "text",
  "publisher": "text",
  "msixImagePath": "text",
  "packagedApps": [
    {
      "name": "text"
    }
  ],
  "dependencies": "text",
  "certificate": {
    "status": [
      "0 = Valid",
      "1 = Expiring",
      "2 = Expired",
      "3 = InProgress",
      "4 = Revoked",
      "5 = Issuing",
      "6 = IssuingFailed",
      "7 = Renewing",
      "8 = RenewingFailed",
      "9 = Revoking",
      "10 = RevokingFailed"
    ],
    "publicKey": "text",
    "expirationDate": "2025-05-09T04:40:27.458Z",
    "keySize": [
      "0 = KeySize1024",
      "1 = KeySize2048",
      "2 = KeySize4096",
      "3 = KeySize3072",
      "4 = KeySize521",
      "255 = KeySizeUnknown"
    ],
    "commonName": "text"
  },
  "siteId": 1,
  "enabled": true,
  "tagIds": [
    1
  ]
}

Update

put

Update application package settings.

Path parameters

idinteger · int32Required

Application package ID.

Body

Modify an Application Package

enabledboolean | nullableOptional

Enable or disable the application package.

displayNamestring | nullableOptional

The new display name of the application package.

tagId1boolean | nullableOptional

Enable or disable Tag with Id 1.

tagId2boolean | nullableOptional

Enable or disable Tag with Id 2.

tagId3boolean | nullableOptional

Enable or disable Tag with Id 3.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "enabled": true,
  "displayName": "text",
  "tagId1": true,
  "tagId2": true,
  "tagId3": true
}

No content

Update

put

Update RAS Agent Log level.

Query parameters

serverstringOptional

RAS Agent Server name

siteIdinteger · int32Optional

Site ID of the specified server

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:

Body

Update the Log Level of an Agent

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:

serverstring | nullableOptional

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

logLevelstring · enumRequired

RAS Log Level

Possible values:

durationInSecinteger · int32Optional

RAS Log Level Duration The duration before the log level is reset back to Standard level (in seconds). Only applies for 'Extended' and 'Verbose' levels (Default: 43200 (12 hours), Max: 259200 (72 hours), Never: 0).

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/Agent/logs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 241

{
  "serverType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "7 = Broker",
    "25 = HALBDevice",
    "-1 = All"
  ],
  "server": "text",
  "logLevel": [
    "0 = Critical",
    "1 = Error",
    "2 = Warning",
    "3 = Standard",
    "4 = Extended",
    "5 = Verbose",
    "-1 = None"
  ],
  "durationInSec": 1
}

No content

Delete

delete

Clear RAS Agent Log(s).

Query parameters

serverstringOptional

RAS Agent Server name

siteIdinteger · int32Optional

Site ID of the specified server

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:

Body

RAS Agent log

serverTypestring · enumOptional

RAS Logging Server Type

Possible values:

serverstring | nullableOptional

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/Agent/logs HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 113

{
  "serverType": [
    "1 = RDS",
    "2 = Provider",
    "3 = Gateway",
    "7 = Broker",
    "25 = HALBDevice",
    "-1 = All"
  ],
  "server": "text"
}

No content

Update

put

Modify RAS Agent.

Query parameters

serverstringOptional

RAS Agent Server name

siteIdinteger · int32Optional

Site ID in which to modify the specified server.

forcebooleanOptional

When 'Force' is passed, only the known info will be used and force the operation.

usernamestringOptional

An administrator account to remotely perform operation on the RAS agent from the server.

passwordstringOptional

The password of the account specified in the Username parameter.

Body

Execute an action in a RAS Agent

serverstring | nullableRequired

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

forcebooleanOptional

When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

Default: false

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/Agent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 30

{
  "server": "text",
  "force": true
}

No content

Delete

delete

Remove RAS Agent.

Query parameters

serverstringOptional

RAS Agent Server name

siteIdinteger · int32Optional

Site ID from which to delete the specified server.

forcebooleanOptional

When 'Force' is passed, only the known info will be used and force the operation.

usernamestringOptional

An administrator account to remotely perform operation on the RAS agent from the server.

passwordstringOptional

The password of the account specified in the Username parameter.

Body

Execute an action in a RAS Agent

serverstring | nullableRequired

The name of the RAS agent server. The name can be either FQDN or IP address, but you have to enter the actual name this server has in the RAS farm.

forcebooleanOptional

When 'Force' is passed, only the known info will be used and force the operation. If the parameter is omitted, the RAS Agent info is retrieved with the supplied info.

Default: false

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/Agent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 30

{
  "server": "text",
  "force": true
}

No content

Add

post

Add a user or group to the Assignment List of the AVD Host Pool.

Path parameters

idinteger · int32Required

The ID of an AVD Host Pool for which to modify the Assignment settings.

Body

Add a user or group account to the AVD Host Pool Assignment list

accountstring | nullableOptional

The name of the account to add to the Assignments.

sidstring | nullableOptional

The SID of the account to add to the Assignments.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/Assignment HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user or group from the Assignment List of the AVD Host Pool.

Path parameters

idinteger · int32Required

The ID of an AVD Host Pool for which to modify the Assignment settings.

Body

Remove a user or group account from the AVD Host Pool Assignment list

accountstring | nullableOptional

The name of the account to remove from the Assignments.

sidstring | nullableOptional

The SID of the account to remove from the Assignments.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/Assignment HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Add

post

Add an assigned application package.

Path parameters

idinteger · int32Required

The ID for which to add the assigned application package.

Body

packageNamestring | nullableRequired

The application package name. This must be the actual application package name used in the RAS farm.

versionstring | nullableRequired

The version of the application package. This must be the actual application package version used in the RAS farm.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/AppPackageAssigned HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 39

{
  "packageName": "text",
  "version": "text"
}

No content

Update

put

Update the assigned application package settings with the specified ID.

Path parameters

idinteger · int32Required

The ID for which to modify the assigned application package setting.

Body

packageNamestring | nullableRequired

The name of the application package for which to change the version. This must be the actual application package name used in the RAS farm.

versionstring | nullableRequired

The new version of the application package. This must be the actual application package version used in the RAS farm.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "packageName": "text",
  "version": "text"
}

No content

Delete

delete

Remove the assigned application package.

Path parameters

idinteger · int32Required

ID for which to remove the assigned application package.

Body

packageNamestring | nullableRequired

The name of the application package for which to remove the assigned packaged application. This must be the actual application package name used in the RAS farm.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/AppPackageAssigned HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "packageName": "text"
}

No content

Create

post

Creates a new Azure Virtual Desktop Host Pool.

Body

namestring | nullableRequired

The name of the AVD Host Pool.

siteIdinteger · int32Optional

Site ID in which to modify the specified AVD Host Pool. If the parameter is omitted, the site ID of the Licensing Server will be used.

workspaceIdinteger · int32Required

The Workspace ID.

descriptionstring | nullableOptional

Description of the AVD Host Pool.

enabledbooleanOptional

Enable or disable the AVD Host Pool upon creation. If the parameter is omitted, the AVD Host Pool is initialised as Disabled.

friendlyNamestring | nullableOptional

Friendly name of the AVD Host Pool.

resourceGroupstring | nullableRequired

Resource Group of the AVD Host Pool.

locationstring | nullableRequired

Location of the AVD Host Pool.

poolTypestring · enumRequired

Pool Type

Possible values:

limitHostsinteger · int32Optional

The Limit of session on host. Default: Pooled: 50, Personal: 1 (always).

publishingTypestring · enumRequired

Publishing Type

Possible values:

loadBalancerTypestring · enumRequired

Load Balancer Type

Possible values:

powerOnHostbooleanOptional

Whether Power On Host is Enabled or not.

validationEnvironmentbooleanOptional

Whether Validation Environment is Enabled or not.

provisioningTypestring · enumRequired

Provisioning Type

Possible values:

templateIdinteger · int32 | nullableOptional

The Template ID.

templateVersionIdinteger · int32 | nullableOptional

The RAS Template Version ID.

autoScaleEnabledboolean | nullableOptional

Whether AutoScale is Enabled or not

minServersFromTemplateinteger · int32Optional

The Minimum Number of Hosts added from the template. Default: 1

maxServersFromTemplateinteger · int32Optional

The Maximum Number of Hosts added from the template. Default: 2

hostNamestring | nullableOptional

The host name format. All VMs created from the template will have this name with %ID:N:S% replaced.

defaultPowerStatestring · enumOptional

Session Type

Possible values:

workloadThresholdinteger · int32Optional

The Workload Threshold. Default: 75

serversToAddPerRequestinteger · int32Optional

The amount of servers to add per request. Default: 1

workLoadDraininteger · int32Optional

The Drain Workload. Default: 20

drainRemainsBelowSecinteger · int32Optional

The Remaining Drain level. Default: 0 (Immediate)

removeServersAfterDrainAndPowerOffboolean | nullableOptional

Remove hosts from host pool after drain and power off.

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/HostPool HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 759

{
  "name": "text",
  "siteId": 1,
  "workspaceId": 1,
  "description": "text",
  "enabled": true,
  "friendlyName": "text",
  "resourceGroup": "text",
  "location": "text",
  "poolType": [
    "0 = Pooled",
    "1 = Personal"
  ],
  "limitHosts": 1,
  "publishingType": [
    "0 = RemoteApp",
    "1 = Desktop"
  ],
  "loadBalancerType": [
    "0 = BreadthFirst",
    "1 = DepthFirst",
    "2 = Persistent"
  ],
  "powerOnHost": true,
  "validationEnvironment": true,
  "provisioningType": [
    "0 = Template",
    "1 = Standalone"
  ],
  "templateId": 1,
  "templateVersionId": 1,
  "autoScaleEnabled": true,
  "minServersFromTemplate": 1,
  "maxServersFromTemplate": 1,
  "hostName": "text",
  "defaultPowerState": [
    "0 = PoweredOn",
    "1 = PoweredOff",
    "2 = Suspended"
  ],
  "workloadThreshold": 1,
  "serversToAddPerRequest": 1,
  "workLoadDrain": 1,
  "drainRemainsBelowSec": 1,
  "removeServersAfterDrainAndPowerOff": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "enabled": true,
  "name": "text",
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text",
  "workspaceId": 1,
  "linkedDesktopApplicationGroup": "text",
  "linkedRemoteApplicationGroup": "text",
  "configuration": {
    "poolType": [
      "0 = Pooled",
      "1 = Personal"
    ],
    "publishingType": [
      "0 = RemoteApp",
      "1 = Desktop"
    ],
    "provisioningType": [
      "0 = Template",
      "1 = Standalone"
    ],
    "loadBalancerType": [
      "0 = BreadthFirst",
      "1 = DepthFirst",
      "2 = Persistent"
    ],
    "powerOnHost": true,
    "validationEnvironment": true,
    "limitHosts": 1,
    "defaultLicenseType": [
      "0 = DoNotConfigure",
      "1 = WindowsClient",
      "2 = WindowsServer"
    ]
  },
  "provisioningSettings": {
    "hostName": "text",
    "defaultPowerState": [
      "0 = PoweredOn",
      "1 = PoweredOff",
      "2 = Suspended"
    ],
    "maxHosts": 1,
    "preCreatedHosts": 1,
    "duration": 1,
    "autoScale": {
      "templateId": 1,
      "templateVersionId": 1,
      "autoScaleEnabled": true,
      "minServersFromTemplate": 1,
      "maxServersFromTemplate": 1,
      "workloadThreshold": 1,
      "serversToAddPerRequest": 1,
      "workLoadDrain": 1,
      "drainRemainsBelowSec": 1,
      "removeServersAfterDrainAndPowerOff": true
    },
    "overwriteSize": true,
    "vmSize": {
      "vmSize": "text",
      "offering": "text",
      "family": "text",
      "vcpUs": 1,
      "ram": "text",
      "dataDisk": 1,
      "maximumIOPS": "text",
      "tempStorage": 1,
      "premiumDiskSupport": [
        "0 = No",
        "1 = Yes"
      ]
    }
  },
  "assignments": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text",
      "azureActiveDirectory": "text",
      "azureActiveDirectoryId": "text"
    }
  ],
  "inheritDefaultAgentSettings": true,
  "agent": {
    "disconnectActiveSessionAfter": 1,
    "logoffDisconnectedSessionAfter": 1,
    "sessionReadinessTimeout": 1,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": true,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowRemoteExec": true,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": true,
    "enableDriveRedirectionCache": true,
    "manageRDPShortpath": true,
    "appMonitor": true,
    "useRDPShortpath": true,
    "useSmallerPortRange": true,
    "minRDPShortpathPort": 1,
    "maxRDPShortpathPort": 1
  },
  "inheritDefaultUserProfileSettings": true,
  "userProfile": {
    "technology": [
      "0 = DoNotManage",
      "1 = UPD",
      "2 = FSLogix"
    ],
    "fsLogix": {
      "profileContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "customizeProfileFolders": true,
        "excludeCommonFolders": [
          "1 = Contacts",
          "2 = Desktop",
          "4 = Documents",
          "8 = Links",
          "16 = MusicPodcasts",
          "32 = PicturesVideos",
          "64 = FoldersLowIntegProcesses",
          "128 = Downloads"
        ],
        "folderInclusionList": [
          "text"
        ],
        "folderExclusionList": [
          {
            "folder": "text",
            "excludeFolderCopy": [
              "0 = None",
              "1 = CopyBase",
              "2 = CopyBack"
            ]
          }
        ],
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useKeepLocalDir": true,
          "keepLocalDir": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useDeleteLocalProfileWhenVHDShouldApply": true,
          "deleteLocalProfileWhenVHDShouldApply": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useProfileDirSDDL": true,
          "profileDirSDDL": "text",
          "useProfileType": true,
          "profileType": [
            "0 = NormalProfile",
            "1 = OnlyRWProfile",
            "2 = OnlyROProfile",
            "3 = RWROProfile"
          ],
          "useSetTempToLocalPath": true,
          "setTempToLocalPath": [
            "0 = TakeNoAction",
            "1 = RedirectTempAndTmp",
            "2 = RedirectINetCache",
            "3 = RedirectTempTmpAndINetCache"
          ],
          "useCleanOutNotifications": true,
          "cleanOutNotifications": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useInstallAppxPackages": true,
          "installAppxPackages": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRebootOnUserLogoff": true,
          "rebootOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamIdentity": true,
          "roamIdentity": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useShutdownOnUserLogoff": true,
          "shutdownOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ]
        }
      },
      "officeContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useIncludeOfficeActivation": true,
          "includeOfficeActivation": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneDrive": true,
          "includeOneDrive": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNote": true,
          "includeOneNote": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNoteUWP": true,
          "includeOneNoteUWP": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlook": true,
          "includeOutlook": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlookPersonalization": true,
          "includeOutlookPersonalization": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSharepoint": true,
          "includeSharepoint": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSkype": true,
          "includeSkype": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeTeams": true,
          "includeTeams": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useMirrorLocalOSTToVHD": true,
          "mirrorLocalOSTToVHD": [
            "0 = DoNothing",
            "1 = Copy",
            "2 = Move"
          ],
          "useNumSessionVHDsToKeep": true,
          "numSessionVHDsToKeep": 1,
          "useOutlookFolderPath": true,
          "outlookFolderPath": "text",
          "useRefreshUserPolicy": true,
          "refreshUserPolicy": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDAccessMode": true,
          "vhdAccessMode": [
            "0 = NormalDirectAccess",
            "1 = DiffDiskNetwork",
            "2 = DiffDiskLocal",
            "3 = UniqueVHDPerSession"
          ]
        }
      },
      "generalSettings": {
        "appServices": {
          "useCleanupInvalidSessions": true,
          "cleanupInvalidSessions": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamRecycleBin": true,
          "roamRecycleBin": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDCompactDisk": true,
          "vhdCompactDisk": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "cloudCacheGeneral": {
          "useCacheDirectory": true,
          "cacheDirectory": "text",
          "useWriteCacheDirectory": true,
          "writeCacheDirectory": "text",
          "useProxyDirectory": true,
          "proxyDirectory": "text",
          "useSilenceACLWarning": true,
          "silenceACLWarning": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "logging": {
          "logEnabled": [
            "0 = Disable",
            "1 = Specific",
            "2 = All"
          ],
          "logLevel": [
            "0 = Debug",
            "1 = Information",
            "2 = Warning",
            "3 = Error"
          ],
          "logFileKeepingPeriod": 1,
          "logDirectory": "text",
          "robocopyLogPath": "text",
          "logSpecificComponents": [
            "1 = ProfileConfigTool",
            "2 = IEPlugin",
            "4 = RuleEditor",
            "8 = JavaRuleEditor",
            "16 = FSLogixAgentService",
            "32 = Profile",
            "64 = JavaLauncher",
            "128 = OfficeContainer",
            "256 = RuleCompilation",
            "512 = FontVisibility",
            "1024 = Network",
            "2048 = PrinterVisibility",
            "4096 = ADSComputerGroup",
            "8192 = DriverInterface",
            "16384 = WindowsSearchRoaming",
            "32768 = WindowsSearchPlugin",
            "65536 = ProcessStartMonitor"
          ]
        }
      }
    }
  },
  "inheritDefaultAppPackageSettings": true,
  "appPackagesAssigned": {
    "applicationPackagesAssigned": [
      {
        "version": "text",
        "tagName": "text",
        "tagId": 1,
        "packageName": "text"
      }
    ]
  },
  "inheritDefaultOptimizationSettings": true,
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "inheritDefaultActionsSettings": true,
  "action": {
    "sessionAction": [
      "0 = Disconnect",
      "1 = Logoff"
    ],
    "performAction": [
      "0 = DoNothing",
      "2 = Shutdown",
      "4 = Suspend",
      "7 = Delete",
      "8 = Restart",
      "9 = Unassign",
      "10 = Recreate"
    ],
    "performActionAfterSec": 1
  },
  "inheritDefaultRDPPrinterSettings": true,
  "rdpPrinter": {
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeSessionNumberFromPrinterName": true,
    "removeClientNameFromPrinterName": true
  },
  "inheritDefaultAutoUpgradeSettings": true,
  "autoUpgrade": {
    "enabled": true,
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "drainModeDurationInSecs": 1,
    "forceLogoffSessions": true,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ]
  }
}

Update

put

Modifies an Azure Virtual Desktop Host Pool.

Path parameters

idinteger · int32Required

The ID of the Azure Virtual Desktop Host Pool to modify.

Body

namestring | nullableOptional

The new name of the Azure Virtual Desktop Host Pool settings.

friendlyNamestring | nullableOptional

The new Friendly Name of the Azure Virtual Desktop Host Pool settings.

descriptionstring | nullableOptional

The new description of the Azure Virtual Desktop Host Pool settings.

enabledboolean | nullableOptional

Enable or disable the specified AVD Host Pool in a site.

powerOnHostboolean | nullableOptional

Whether Power On Host is Enabled or not.

validationEnvironmentboolean | nullableOptional

Whether Validation Environment is Enabled or not.

limitHostsinteger · int32 | nullableOptional

The Limit of session on host.

defaultLicenseTypestring · enumOptional

The AVD License Type

Possible values:

loadBalancerTypestring · enumOptional

Load Balancer Type

Possible values:

technologystring · enumOptional

User Profile Technology values.

Possible values:

disconnectActiveSessionAfterinteger · int32 | nullableOptional

Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

logoffDisconnectedSessionAfterinteger · int32 | nullableOptional

Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.

sessionReadinessTimeoutinteger · int32 | nullableOptional

Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

allowRemoteExecboolean | nullableOptional

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

allowURLAndMailRedirectionstring · enumOptional

URL and Mail Redirection values.

Possible values:

supportShellURLNamespaceObjectsboolean | nullableOptional

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

manageRDPTransportProtocolstring · enumOptional

Manage RDP transport protocol.

Possible values:

dragAndDropModestring · enumOptional

Drag and drop redirection values.

Possible values:

fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:

fileTransferLocationstring | nullableOptional

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean | nullableOptional

Lock Location where the File Transfer takes place, if and where it is allowed.

enableDriveRedirectionCacheboolean | nullableOptional

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

sessionActionstring · enumOptional

Session Action type

Possible values:

performActionstring · enumOptional

Perform Action type

Possible values:

performActionAfterSecinteger · int32 | nullableOptional

Perform action after (in seconds)

templateIdinteger · int32 | nullableOptional

The Template ID.

templateVersionIdinteger · int32 | nullableOptional

The RAS Template Version ID.

autoScaleEnabledboolean | nullableOptional

Whether AutoScale is Enabled or not.

minServersFromTemplateinteger · int32 | nullableOptional

The Minimum Number of Hosts added to the template.

maxServersFromTemplateinteger · int32 | nullableOptional

The Maximum Number of Hosts added to the template.

hostNamestring | nullableOptional

The Host Name Format. All Host Names must adhere to this format : '{text}-%ID:{number}%'

defaultPowerStatestring · enumOptional

Session Type

Possible values:

workloadThresholdinteger · int32 | nullableOptional

The Workload Threshold.

serversToAddPerRequestinteger · int32 | nullableOptional

The amount of servers to add per request.

workLoadDraininteger · int32 | nullableOptional

The Drain Workload.

drainRemainsinteger · int32 | nullableOptional

The Remaining Drain level.

overwriteSizeboolean | nullableOptional

Whether Overwrite Size is Enabled or not.

removeServersAfterDrainAndPowerOffboolean | nullableOptional

Remove hosts from host pool after drain and power off.

printerNameFormatstring · enumOptional

Printer Name Format

Possible values:

removeSessionNumberFromPrinterNameboolean | nullableOptional

Specifies if 'Remove session number from printer name' option is enabled or disabled.

removeClientNameFromPrinterNameboolean | nullableOptional

Specifies if 'Remove client name from printer name' option is enabled or disabled.

appMonitorboolean | nullableOptional

Specifies if 'Enable applications monitoring' option is enabled or disabled.

manageRDPShortpathboolean | nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

useRDPShortpathboolean | nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

useSmallerPortRangeboolean | nullableOptional

Specifies if 'Use Smaller Port' option is enabled or disabled.

minRDPShortpathPortinteger · int32 | nullableOptional

The minimum RDP Shortpath Port.

maxRDPShortpathPortinteger · int32 | nullableOptional

The maximum RDP Shortpath Port.

inheritDefaultAgentSettingsboolean | nullableOptional

If true, default AVD Agent settings will be inherited.

inheritDefaultUserProfileSettingsboolean | nullableOptional

If true, default User Profile settings will be inherited.

inheritDefaultAppPackageSettingsboolean | nullableOptional

If true, default Application Package settings will be inherited.

inheritDefaultOptimizationSettingsboolean | nullableOptional

If true, default Optimization settings will be inherited.

inheritDefaultActionsSettingsboolean | nullableOptional

If true, default Action settings will be inherited.

inheritDefaultRDPPrinterSettingsboolean | nullableOptional

If true, default Printing settings will be inherited.

inheritDefaultAutoUpgradeSettingsboolean | nullableOptional

If true, default Auto-upgrade settings will be inherited.

Responses

204

No Content

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "name": "text",
  "friendlyName": "text",
  "description": "text",
  "enabled": true,
  "powerOnHost": true,
  "validationEnvironment": true,
  "limitHosts": 1,
  "defaultLicenseType": [
    "0 = DoNotConfigure",
    "1 = WindowsClient",
    "2 = WindowsServer"
  ],
  "loadBalancerType": [
    "0 = BreadthFirst",
    "1 = DepthFirst",
    "2 = Persistent"
  ],
  "technology": [
    "0 = DoNotManage",
    "1 = UPD",
    "2 = FSLogix"
  ],
  "disconnectActiveSessionAfter": 1,
  "logoffDisconnectedSessionAfter": 1,
  "sessionReadinessTimeout": 1,
  "allowRemoteExec": true,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": true,
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "dragAndDropMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": true,
  "enableDriveRedirectionCache": true,
  "sessionAction": [
    "0 = Disconnect",
    "1 = Logoff"
  ],
  "performAction": [
    "0 = DoNothing",
    "2 = Shutdown",
    "4 = Suspend",
    "7 = Delete",
    "8 = Restart",
    "9 = Unassign",
    "10 = Recreate"
  ],
  "performActionAfterSec": 1,
  "templateId": 1,
  "templateVersionId": 1,
  "autoScaleEnabled": true,
  "minServersFromTemplate": 1,
  "maxServersFromTemplate": 1,
  "hostName": "text",
  "defaultPowerState": [
    "0 = PoweredOn",
    "1 = PoweredOff",
    "2 = Suspended"
  ],
  "workloadThreshold": 1,
  "serversToAddPerRequest": 1,
  "workLoadDrain": 1,
  "drainRemains": 1,
  "overwriteSize": true,
  "removeServersAfterDrainAndPowerOff": true,
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "removeSessionNumberFromPrinterName": true,
  "removeClientNameFromPrinterName": true,
  "appMonitor": true,
  "manageRDPShortpath": true,
  "useRDPShortpath": true,
  "useSmallerPortRange": true,
  "minRDPShortpathPort": 1,
  "maxRDPShortpathPort": 1,
  "inheritDefaultAgentSettings": true,
  "inheritDefaultUserProfileSettings": true,
  "inheritDefaultAppPackageSettings": true,
  "inheritDefaultOptimizationSettings": true,
  "inheritDefaultActionsSettings": true,
  "inheritDefaultRDPPrinterSettings": true,
  "inheritDefaultAutoUpgradeSettings": true
}

No content

Update

put

Update the Image Optimization settings with the specified ID.

Path parameters

idinteger · int32Required

The ID for which to modify the Image Optimization.

Body

enableOptimizationboolean | nullableOptional

Whether Optimization is Enabled or not

optimizationTypestring · enumOptional

Optimization Type

Possible values:

windowsDefenderATPEnabledboolean | nullableOptional

Whether Windows Defender ATP is enabled or not

windowsComponentsEnabledboolean | nullableOptional

Whether Windows Components is enabled or not

windowsServicesEnabledboolean | nullableOptional

Whether Windows Services is enabled or not

windowsScheduledTasksEnabledboolean | nullableOptional

Whether Windows Scheduled Task is enabled or not

windowsAdvancedOptionsEnabledboolean | nullableOptional

Whether Windows Advanced Options is enabled or not

networkPerformanceEnabledboolean | nullableOptional

Whether Network Performance is enabled or not

registryEnabledboolean | nullableOptional

Whether Registry is enabled or not

visualEffectsEnabledboolean | nullableOptional

Whether Visual Effects is enabled or not

diskCleanupEnabledboolean | nullableOptional

Whether Disk Cleanup is enabled or not

customScriptEnabledboolean | nullableOptional

Whether Custom Script is enabled or not

winDefATPTurnOffOnstring · enumOptional

Windows enable options

Possible values:

disableRealTimeProtectionboolean | nullableOptional

Disable Real Time Protection

excludeFoldersstring[] | nullableOptional

Exclude Folders List

excludeProcessesstring[] | nullableOptional

Exclude Processes

excludeExtensionstring[] | nullableOptional

Exclude Extensions

partialStartLayoutContentstring | nullableOptional

Partial Start menu layout

hibernateboolean | nullableOptional

Whether Hibernate is enabled or not

teleCollectionboolean | nullableOptional

Whether TeleCollection is enabled or not

systemRestoreboolean | nullableOptional

Whether System Restore is enabled or not

additionalErrorReportboolean | nullableOptional

Whether Additional Error Reporting is enabled or not

tilesboolean | nullableOptional

Whether Tiles is enabled or not

cortanaboolean | nullableOptional

Whether Cortana is enabled or not

microsoftConsumerExperienceboolean | nullableOptional

Whether Microsoft Consumer Experience is enabled or not

windowsTipsboolean | nullableOptional

Whether Windows Tips is enabled or not

commonProgramGroupsboolean | nullableOptional

Whether Common Program Groups is enabled or not

partialStartMenuboolean | nullableOptional

Whether Partial Start Menu is enabled or not

dirCacheMaxinteger · int32 | nullableOptional

Directory Cache Value

dormantFileLimitinteger · int32 | nullableOptional

Dormant File Limit Value

fileNotFoundCacheinteger · int32 | nullableOptional

File Not Found Cache Value

fileInfoCacheinteger · int32 | nullableOptional

File Info Cache Value

fileInfoCacheEnableboolean | nullableOptional

Whether File Info Cache is enabled or not

directoryCacheEnableboolean | nullableOptional

Whether Directory Cache is enabled or not

fileNotFoundCacheEnableboolean | nullableOptional

Whether File Not Found Cache is enabled or not

dormantFileLimitEnableboolean | nullableOptional

Whether Dormant File Limit is enabled or not

disableTCPboolean | nullableOptional

Whether Disable TCP is enabled or not

disableIPv6CompEnableboolean | nullableOptional

Whether Disable IPv6 Components is enabled or not

disableIPv6ToIPv4boolean | nullableOptional

Whether Disable IPv6 To IPv4 is enabled or not

disableIsaTapboolean | nullableOptional

Whether Disable IsaTap for IPv6 is enabled or not

argumentsstring | nullableOptional

Arguments

commandstring | nullableOptional

Command

initDirstring | nullableOptional

Initial Directory

userstring | nullableOptional

User

passwordstring | nullableOptional

Password

cleanupWinSxSFolderboolean | nullableOptional

Whether Clean up windows SxS Folder is enabled or not

cleanupSystemFilesboolean | nullableOptional

Whether Clean up system files is enabled or not

cleanupTemporaryFileLogsboolean | nullableOptional

Whether Clean up temporary file logs is enabled or not

removeOneDriveboolean | nullableOptional

Whether Remove One Drives is enabled or not

deleteUserProfilesboolean | nullableOptional

Whether Delete User Profiles is enabled or not

visualEffectsTypesstring · enumOptional

Visual Effects Type

Possible values:

animateControlSelectElementsboolean | nullableOptional

Whether Animate Control Select Elements is enabled or not

animateWindowsWhenMinimizingMaximizingboolean | nullableOptional

Whether Animate Windows When Minimizing Or Maximizing is enabled or not

animateTaskbarboolean | nullableOptional

Whether Animate Taskbar is enabled or not

enablePeekboolean | nullableOptional

Whether Peek is enabled or not

fadeSlideMenusboolean | nullableOptional

Whether Fade Slide Menus is enabled or not

fadeSlideToolTipsboolean | nullableOptional

Whether Fade Slide Tool Tips is enabled or not

fadeOutMenuItemsboolean | nullableOptional

Whether Fade Out Menu Items is enabled or not

saveTaskbarThumbnailboolean | nullableOptional

Whether Taskbar Thumbnail is enabled or not

showShadowUnderMouseboolean | nullableOptional

Whether Shadow Under Mouse is enabled or not

shadowUnderWindowsboolean | nullableOptional

Whether Shadow Under Windows is enabled or not

thumbnailsInsteadOfIconsboolean | nullableOptional

Whether Thumbnails instead of icons is enabled or not

showTranslucentSelectionboolean | nullableOptional

Whether Translucent Selection is enabled or not

showWindowsContentWhilstDraggingboolean | nullableOptional

Whether Windows Content Whilst Dragging is enabled or not

slideOpenComboBoxesboolean | nullableOptional

Whether Slide open combo boxes is enabled or not

smoothEdgesScreenFontsboolean | nullableOptional

Whether Smooth Edges Screen Fonts is enabled or not

smoothScrollListBoxesboolean | nullableOptional

Whether Smooth Scroll List Boxes is enabled or not

dropShadowsIconboolean | nullableOptional

Whether Drop Shadow Icon is enabled or not

forcebooleanOptional

Force Optimization.

Default: false

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "winDefATPTurnOffOn": [
    "0 = TurnOffWindowsDefenderATP",
    "1 = TurnOnWindowsDefenderATP"
  ],
  "disableRealTimeProtection": true,
  "excludeFolders": [
    "text"
  ],
  "excludeProcesses": [
    "text"
  ],
  "excludeExtension": [
    "text"
  ],
  "partialStartLayoutContent": "text",
  "hibernate": true,
  "teleCollection": true,
  "systemRestore": true,
  "additionalErrorReport": true,
  "tiles": true,
  "cortana": true,
  "microsoftConsumerExperience": true,
  "windowsTips": true,
  "commonProgramGroups": true,
  "partialStartMenu": true,
  "dirCacheMax": 1,
  "dormantFileLimit": 1,
  "fileNotFoundCache": 1,
  "fileInfoCache": 1,
  "fileInfoCacheEnable": true,
  "directoryCacheEnable": true,
  "fileNotFoundCacheEnable": true,
  "dormantFileLimitEnable": true,
  "disableTCP": true,
  "disableIPv6CompEnable": true,
  "disableIPv6ToIPv4": true,
  "disableIsaTap": true,
  "arguments": "text",
  "command": "text",
  "initDir": "text",
  "user": "text",
  "password": "text",
  "cleanupWinSxSFolder": true,
  "cleanupSystemFiles": true,
  "cleanupTemporaryFileLogs": true,
  "removeOneDrive": true,
  "deleteUserProfiles": true,
  "visualEffectsTypes": [
    "0 = LetWindowsChooseWhatsBest",
    "1 = AdjustForBestAppearance",
    "2 = AdjustForBestPerformance",
    "3 = Custom"
  ],
  "animateControlSelectElements": true,
  "animateWindowsWhenMinimizingMaximizing": true,
  "animateTaskbar": true,
  "enablePeek": true,
  "fadeSlideMenus": true,
  "fadeSlideToolTips": true,
  "fadeOutMenuItems": true,
  "saveTaskbarThumbnail": true,
  "showShadowUnderMouse": true,
  "shadowUnderWindows": true,
  "thumbnailsInsteadOfIcons": true,
  "showTranslucentSelection": true,
  "showWindowsContentWhilstDragging": true,
  "slideOpenComboBoxes": true,
  "smoothEdgesScreenFonts": true,
  "smoothScrollListBoxes": true,
  "dropShadowsIcon": true,
  "force": true
}

No content

Create

post

Create an Auto-upgrade Message.

Path parameters

idinteger · int32Required

The ID of the Auto-upgrade setting for which to create the message.

Body

Add a message to the Auto-upgrade message list

enabledbooleanOptional

Whether to enable or disable the message.

messageTitlestring | nullableRequired

The title of the message.

messagestring | nullableRequired

A message that should be sent to users before the job starts.

sendMsgSecsinteger · int32Optional

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenstring · enumOptional

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/AutoUpgrade/Messages HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

{
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

No content

Update

put

Update an Auto-upgrade Message.

Path parameters

idinteger · int32Required

The ID of the Auto-upgrade setting for which to modify the message.

messageIdinteger · int32Required

The ID of the message to modify.

Body

Modify a message within the Auto-upgrade message list

enabledboolean | nullableOptional

Whether to enable or disable the message.

messageTitlestring | nullableOptional

The title of the message.

messagestring | nullableOptional

A message that should be sent to users before the job starts.

sendMsgSecsinteger · int32 | nullableOptional

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenstring · enumOptional

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/HostPool/{id}/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

{
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

No content

Import

post

Creates an Azure Virtual Desktop Host Pool from an existing Host Pool.

Body

siteIdinteger · int32Optional

Site ID in which to modify the specified AVD Host Pool. If the parameter is omitted, the site ID of the Licensing Server will be used.

workspaceIdinteger · int32Required

The Workspace ID.

enabledbooleanOptional

Enable or disable the AVD Host Pool upon creation. If the parameter is omitted, the AVD Host Pool is initialised as Disabled.

azureIdstring | nullableRequired

The Azure ID of the AVD Host Pool.

validationEnvironmentbooleanOptional

Whether Validation Environment is Enabled or not.

templateIdinteger · int32 | nullableOptional

The Template ID.

templateVersionIdinteger · int32 | nullableOptional

The RAS Template Version ID.

autoScaleEnabledboolean | nullableOptional

Whether AutoScale is Enabled or not

minServersFromTemplateinteger · int32Optional

The Minimum Number of Hosts added from the template. Default: 1

maxServersFromTemplateinteger · int32Optional

The Maximum Number of Hosts added from the template. Default: 2

hostNamestring | nullableOptional

The host name format. All VMs created from the template will have this name with %ID:N:S% replaced.

defaultPowerStatestring · enumOptional

Session Type

Possible values:

workloadThresholdinteger · int32Optional

The Workload Threshold. Default: 75

serversToAddPerRequestinteger · int32Optional

The amount of servers to add per request. Default: 1

workLoadDraininteger · int32Optional

The Drain Workload. Default: 20

drainRemainsBelowSecinteger · int32Optional

The Remaining Drain level. Default: 0 (Immediate)

removeServersAfterDrainAndPowerOffboolean | nullableOptional

Remove hosts from host pool after drain and power off.

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/HostPool/Existing HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 427

{
  "siteId": 1,
  "workspaceId": 1,
  "enabled": true,
  "azureId": "text",
  "validationEnvironment": true,
  "templateId": 1,
  "templateVersionId": 1,
  "autoScaleEnabled": true,
  "minServersFromTemplate": 1,
  "maxServersFromTemplate": 1,
  "hostName": "text",
  "defaultPowerState": [
    "0 = PoweredOn",
    "1 = PoweredOff",
    "2 = Suspended"
  ],
  "workloadThreshold": 1,
  "serversToAddPerRequest": 1,
  "workLoadDrain": 1,
  "drainRemainsBelowSec": 1,
  "removeServersAfterDrainAndPowerOff": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "enabled": true,
  "name": "text",
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text",
  "workspaceId": 1,
  "linkedDesktopApplicationGroup": "text",
  "linkedRemoteApplicationGroup": "text",
  "configuration": {
    "poolType": [
      "0 = Pooled",
      "1 = Personal"
    ],
    "publishingType": [
      "0 = RemoteApp",
      "1 = Desktop"
    ],
    "provisioningType": [
      "0 = Template",
      "1 = Standalone"
    ],
    "loadBalancerType": [
      "0 = BreadthFirst",
      "1 = DepthFirst",
      "2 = Persistent"
    ],
    "powerOnHost": true,
    "validationEnvironment": true,
    "limitHosts": 1,
    "defaultLicenseType": [
      "0 = DoNotConfigure",
      "1 = WindowsClient",
      "2 = WindowsServer"
    ]
  },
  "provisioningSettings": {
    "hostName": "text",
    "defaultPowerState": [
      "0 = PoweredOn",
      "1 = PoweredOff",
      "2 = Suspended"
    ],
    "maxHosts": 1,
    "preCreatedHosts": 1,
    "duration": 1,
    "autoScale": {
      "templateId": 1,
      "templateVersionId": 1,
      "autoScaleEnabled": true,
      "minServersFromTemplate": 1,
      "maxServersFromTemplate": 1,
      "workloadThreshold": 1,
      "serversToAddPerRequest": 1,
      "workLoadDrain": 1,
      "drainRemainsBelowSec": 1,
      "removeServersAfterDrainAndPowerOff": true
    },
    "overwriteSize": true,
    "vmSize": {
      "vmSize": "text",
      "offering": "text",
      "family": "text",
      "vcpUs": 1,
      "ram": "text",
      "dataDisk": 1,
      "maximumIOPS": "text",
      "tempStorage": 1,
      "premiumDiskSupport": [
        "0 = No",
        "1 = Yes"
      ]
    }
  },
  "assignments": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text",
      "azureActiveDirectory": "text",
      "azureActiveDirectoryId": "text"
    }
  ],
  "inheritDefaultAgentSettings": true,
  "agent": {
    "disconnectActiveSessionAfter": 1,
    "logoffDisconnectedSessionAfter": 1,
    "sessionReadinessTimeout": 1,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": true,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowRemoteExec": true,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": true,
    "enableDriveRedirectionCache": true,
    "manageRDPShortpath": true,
    "appMonitor": true,
    "useRDPShortpath": true,
    "useSmallerPortRange": true,
    "minRDPShortpathPort": 1,
    "maxRDPShortpathPort": 1
  },
  "inheritDefaultUserProfileSettings": true,
  "userProfile": {
    "technology": [
      "0 = DoNotManage",
      "1 = UPD",
      "2 = FSLogix"
    ],
    "fsLogix": {
      "profileContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "customizeProfileFolders": true,
        "excludeCommonFolders": [
          "1 = Contacts",
          "2 = Desktop",
          "4 = Documents",
          "8 = Links",
          "16 = MusicPodcasts",
          "32 = PicturesVideos",
          "64 = FoldersLowIntegProcesses",
          "128 = Downloads"
        ],
        "folderInclusionList": [
          "text"
        ],
        "folderExclusionList": [
          {
            "folder": "text",
            "excludeFolderCopy": [
              "0 = None",
              "1 = CopyBase",
              "2 = CopyBack"
            ]
          }
        ],
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useKeepLocalDir": true,
          "keepLocalDir": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useDeleteLocalProfileWhenVHDShouldApply": true,
          "deleteLocalProfileWhenVHDShouldApply": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useProfileDirSDDL": true,
          "profileDirSDDL": "text",
          "useProfileType": true,
          "profileType": [
            "0 = NormalProfile",
            "1 = OnlyRWProfile",
            "2 = OnlyROProfile",
            "3 = RWROProfile"
          ],
          "useSetTempToLocalPath": true,
          "setTempToLocalPath": [
            "0 = TakeNoAction",
            "1 = RedirectTempAndTmp",
            "2 = RedirectINetCache",
            "3 = RedirectTempTmpAndINetCache"
          ],
          "useCleanOutNotifications": true,
          "cleanOutNotifications": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useInstallAppxPackages": true,
          "installAppxPackages": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRebootOnUserLogoff": true,
          "rebootOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamIdentity": true,
          "roamIdentity": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useShutdownOnUserLogoff": true,
          "shutdownOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ]
        }
      },
      "officeContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useIncludeOfficeActivation": true,
          "includeOfficeActivation": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneDrive": true,
          "includeOneDrive": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNote": true,
          "includeOneNote": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNoteUWP": true,
          "includeOneNoteUWP": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlook": true,
          "includeOutlook": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlookPersonalization": true,
          "includeOutlookPersonalization": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSharepoint": true,
          "includeSharepoint": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSkype": true,
          "includeSkype": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeTeams": true,
          "includeTeams": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useMirrorLocalOSTToVHD": true,
          "mirrorLocalOSTToVHD": [
            "0 = DoNothing",
            "1 = Copy",
            "2 = Move"
          ],
          "useNumSessionVHDsToKeep": true,
          "numSessionVHDsToKeep": 1,
          "useOutlookFolderPath": true,
          "outlookFolderPath": "text",
          "useRefreshUserPolicy": true,
          "refreshUserPolicy": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDAccessMode": true,
          "vhdAccessMode": [
            "0 = NormalDirectAccess",
            "1 = DiffDiskNetwork",
            "2 = DiffDiskLocal",
            "3 = UniqueVHDPerSession"
          ]
        }
      },
      "generalSettings": {
        "appServices": {
          "useCleanupInvalidSessions": true,
          "cleanupInvalidSessions": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamRecycleBin": true,
          "roamRecycleBin": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDCompactDisk": true,
          "vhdCompactDisk": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "cloudCacheGeneral": {
          "useCacheDirectory": true,
          "cacheDirectory": "text",
          "useWriteCacheDirectory": true,
          "writeCacheDirectory": "text",
          "useProxyDirectory": true,
          "proxyDirectory": "text",
          "useSilenceACLWarning": true,
          "silenceACLWarning": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "logging": {
          "logEnabled": [
            "0 = Disable",
            "1 = Specific",
            "2 = All"
          ],
          "logLevel": [
            "0 = Debug",
            "1 = Information",
            "2 = Warning",
            "3 = Error"
          ],
          "logFileKeepingPeriod": 1,
          "logDirectory": "text",
          "robocopyLogPath": "text",
          "logSpecificComponents": [
            "1 = ProfileConfigTool",
            "2 = IEPlugin",
            "4 = RuleEditor",
            "8 = JavaRuleEditor",
            "16 = FSLogixAgentService",
            "32 = Profile",
            "64 = JavaLauncher",
            "128 = OfficeContainer",
            "256 = RuleCompilation",
            "512 = FontVisibility",
            "1024 = Network",
            "2048 = PrinterVisibility",
            "4096 = ADSComputerGroup",
            "8192 = DriverInterface",
            "16384 = WindowsSearchRoaming",
            "32768 = WindowsSearchPlugin",
            "65536 = ProcessStartMonitor"
          ]
        }
      }
    }
  },
  "inheritDefaultAppPackageSettings": true,
  "appPackagesAssigned": {
    "applicationPackagesAssigned": [
      {
        "version": "text",
        "tagName": "text",
        "tagId": 1,
        "packageName": "text"
      }
    ]
  },
  "inheritDefaultOptimizationSettings": true,
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "inheritDefaultActionsSettings": true,
  "action": {
    "sessionAction": [
      "0 = Disconnect",
      "1 = Logoff"
    ],
    "performAction": [
      "0 = DoNothing",
      "2 = Shutdown",
      "4 = Suspend",
      "7 = Delete",
      "8 = Restart",
      "9 = Unassign",
      "10 = Recreate"
    ],
    "performActionAfterSec": 1
  },
  "inheritDefaultRDPPrinterSettings": true,
  "rdpPrinter": {
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeSessionNumberFromPrinterName": true,
    "removeClientNameFromPrinterName": true
  },
  "inheritDefaultAutoUpgradeSettings": true,
  "autoUpgrade": {
    "enabled": true,
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "drainModeDurationInSecs": 1,
    "forceLogoffSessions": true,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ]
  }
}

Update

put

Update the Auto-upgrade settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the Auto-upgrade settings.

Body

objectOptional

Modify the Auto-upgrade settings

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{}

No content

Add

post

Adds a Windows Component Custom to optimization.

Path parameters

idinteger · int32Required

The ID of the Optimization settings to add the windows component custom.

Body

aliasesstring | nullableOptional

Windows Components Alias

displayNamestring | nullableOptional

Windows Components Diplay Name

componentNamestring | nullableOptional

Windows Components Name

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/Optimization/WindowsComponent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 62

{
  "aliases": "text",
  "displayName": "text",
  "componentName": "text"
}

No content

Delete

delete

Removes Windows Component Custom From Optimization.

Path parameters

idinteger · int32Required

The ID of the optimization setting to remove the windows component custom.

Body

componentNamestring | nullableOptional

Windows Component Name

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/Optimization/WindowsComponent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 24

{
  "componentName": "text"
}

No content

Add

post

Adds Registry to the optimization.

Path parameters

idinteger · int32Required

The ID of the optimization to retrieve the registry.

Body

actionstring · enumOptional

The action type for add registry entry

Possible values:

registryNamestring | nullableOptional

Name

dwordValueinteger · int32Optional

Value

displayNamestring | nullableRequired

Display Name

hiveTypestring · enumOptional

The hive type for add registry entry

Possible values:

pathstring | nullableRequired

Path

regTypestring · enumOptional

The value type for add registry entry

Possible values:

stringValuestring | nullableOptional

String Value

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/Optimization/Registry HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 342

{
  "action": [
    "0 = Add",
    "1 = Modify",
    "2 = Delete"
  ],
  "registryName": "text",
  "dwordValue": 1,
  "displayName": "text",
  "hiveType": [
    "0 = HKEY_CURRENT_CONFIG",
    "1 = HKEY_USERS",
    "2 = HKEY_LOCAL_MACHINE",
    "3 = HKEY_CLASSES_ROOT"
  ],
  "path": "text",
  "regType": [
    "0 = REG_SZ",
    "1 = REG_DWORD",
    "2 = REG_QWORD",
    "3 = REG_MULTI_SZ",
    "4 = REG_EXPAND_SZ"
  ],
  "stringValue": "text"
}

No content

Delete

delete

Remove Registry Image Optimization Object.

Path parameters

idinteger · int32Required

Id Of the Optimization Settings to remove the registry object.

Body

registryIdinteger · int32Required

Registry Id

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/Optimization/Registry HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 16

{
  "registryId": 1
}

No content

Create Disable

post

Creates a new disable Schedule.

Body

namestring | nullableRequired

Schedule name.

siteIdinteger · int32Optional

Site ID from which to retrieve the schedule.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

typeinteger · int32 | nullableOptional

Schedule type

startDateTimestring · date-timeOptional

Start time. Default: Now.

durationInSecsnumber · double | nullableOptional

Duration in seconds.

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

completeIninteger · int32 | nullableOptional

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypeinteger · int32 | nullableOptional

Whether to select the percentage or specific number of members to be started

percentageMembersinteger · int32 | nullableOptional

Percentage of members to be started

membersToStartinteger · int32 | nullableOptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableOptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableOptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableOptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableOptional

Enforce schedule for currently inactive host

onDisableboolean | nullableOptional

What action to take on Disable

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/Schedule/Disable HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597

{
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "type": 1,
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "durationInSecs": 1,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "completeIn": 1,
  "poolMembersType": 1,
  "percentageMembers": 1,
  "membersToStart": 1,
  "powerOnAssignedPoolMembers": 1,
  "enableDrainMode": true,
  "forceServerRebootAfter": 1,
  "enforceScheduleInactiveHost": true,
  "onDisable": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "endDateTime": "2025-05-09T04:40:27.458Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Create Shutdown

post

Creates a new Shutdown Schedule.

Body

namestring | nullableRequired

Schedule name.

siteIdinteger · int32Optional

Site ID from which to retrieve the schedule.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

typeinteger · int32 | nullableOptional

Schedule type

startDateTimestring · date-timeOptional

Start time. Default: Now.

durationInSecsnumber · double | nullableOptional

Duration in seconds.

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

completeIninteger · int32 | nullableOptional

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypeinteger · int32 | nullableOptional

Whether to select the percentage or specific number of members to be started

percentageMembersinteger · int32 | nullableOptional

Percentage of members to be started

membersToStartinteger · int32 | nullableOptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableOptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableOptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableOptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableOptional

Enforce schedule for currently inactive host

onDisableboolean | nullableOptional

What action to take on Disable

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/Schedule/Shutdown HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597

{
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "type": 1,
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "durationInSecs": 1,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "completeIn": 1,
  "poolMembersType": 1,
  "percentageMembers": 1,
  "membersToStart": 1,
  "powerOnAssignedPoolMembers": 1,
  "enableDrainMode": true,
  "forceServerRebootAfter": 1,
  "enforceScheduleInactiveHost": true,
  "onDisable": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "endDateTime": "2025-05-09T04:40:27.458Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

List

get

Retrieve Schedule Message(s).

Path parameters

idinteger · int32Required

The ID of the Schedule setting for which to retrieve the messages.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/Schedule/{id}/Messages HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }
]

Get

get

Retrieve a Schedule Message.

Path parameters

idinteger · int32Required

The ID of the Schedule setting for which to retrieve the message.

messageIdinteger · int32Required

The ID of the message to retrieve.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Delete

delete

Delete a Schedule Message by ID.

Path parameters

idinteger · int32Required

The ID of the Schedule setting for which to remove the message.

messageIdinteger · int32Required

The ID of the message to remove.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieves a list of AVD Host Pools status information.

Query parameters

SiteIdinteger · int32Optional

The site ID for which to retrieve all the AVD Host Pool status information (optional)

NamestringOptional

Filter the result by host pool name (optional)

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/HostPool/status HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "siteId": 1,
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "name": "text",
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "brokenReason": [
      "0 = MissingObj",
      "1 = InvalidTags",
      "2 = MissingDAGObj",
      "3 = InvalidDAGTags",
      "4 = MissingDAGRoles",
      "5 = MissingDAGWorkspaceLink",
      "6 = HostpoolAutomaticAssignment",
      "7 = MissingRAGObj",
      "8 = InvalidRAGTags",
      "9 = MissingRAGRoles",
      "10 = MissingRAGWorkspaceLink",
      "11 = MissingRAGRemoteApp",
      "12 = MissingObjectID",
      "-1 = Ignore"
    ]
  }
]

Get

get

Retrieve the AVD Host Pool status information.

Path parameters

idinteger · int32Required

AVD Host Pool ID

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/HostPool/{id}/status HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "siteId": 1,
  "serverType": [
    "1 = RDSHost",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = PA",
    "9 = Site",
    "16 = RDSGroup",
    "25 = HALBDevice",
    "45 = TenantBroker",
    "46 = Enrollment",
    "51 = HALB",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "95 = VDITemplateVersion",
    "96 = AVDTemplateVersion",
    "97 = RDSTemplateVersion",
    "107 = RDSTemplate",
    "108 = VDITemplate",
    "2013 = VDIHost",
    "-1 = All"
  ],
  "name": "text",
  "agentState": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ],
  "brokenReason": [
    "0 = MissingObj",
    "1 = InvalidTags",
    "2 = MissingDAGObj",
    "3 = InvalidDAGTags",
    "4 = MissingDAGRoles",
    "5 = MissingDAGWorkspaceLink",
    "6 = HostpoolAutomaticAssignment",
    "7 = MissingRAGObj",
    "8 = InvalidRAGTags",
    "9 = MissingRAGRoles",
    "10 = MissingRAGWorkspaceLink",
    "11 = MissingRAGRemoteApp",
    "12 = MissingObjectID",
    "-1 = Ignore"
  ]
}

Get

get

Retrieves the FSLogix General Settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix General Settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/General HTTP/1.1
Host: 
Accept: */*

{
  "appServices": {
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "cloudCacheGeneral": {
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "logging": {
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }
}

List

get

Retrieve Windows Scheduled Task

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the windows scheduled task.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Accept: */*

[
  {
    "task": "text",
    "location": "text",
    "type": [
      "0 = Folder",
      "1 = Task"
    ]
  }
]

List

get

Retrieve Windows Service Custom

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the windows service custom list.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/Optimization/WindowsService HTTP/1.1
Host: 
Accept: */*

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "serviceName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Get

get

Retrieves FSLogix Office Container User Exclusion List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Office Container settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Get

get

Retrieve the FSLogix Profile Container settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "customizeProfileFolders": true,
  "excludeCommonFolders": [
    "1 = Contacts",
    "2 = Desktop",
    "4 = Documents",
    "8 = Links",
    "16 = MusicPodcasts",
    "32 = PicturesVideos",
    "64 = FoldersLowIntegProcesses",
    "128 = Downloads"
  ],
  "folderInclusionList": [
    "text"
  ],
  "folderExclusionList": [
    {
      "folder": "text",
      "excludeFolderCopy": [
        "0 = None",
        "1 = CopyBase",
        "2 = CopyBack"
      ]
    }
  ],
  "advancedSettings": {
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useKeepLocalDir": true,
    "keepLocalDir": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useDeleteLocalProfileWhenVHDShouldApply": true,
    "deleteLocalProfileWhenVHDShouldApply": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useProfileDirSDDL": true,
    "profileDirSDDL": "text",
    "useProfileType": true,
    "profileType": [
      "0 = NormalProfile",
      "1 = OnlyRWProfile",
      "2 = OnlyROProfile",
      "3 = RWROProfile"
    ],
    "useSetTempToLocalPath": true,
    "setTempToLocalPath": [
      "0 = TakeNoAction",
      "1 = RedirectTempAndTmp",
      "2 = RedirectINetCache",
      "3 = RedirectTempTmpAndINetCache"
    ],
    "useCleanOutNotifications": true,
    "cleanOutNotifications": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useInstallAppxPackages": true,
    "installAppxPackages": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRebootOnUserLogoff": true,
    "rebootOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamIdentity": true,
    "roamIdentity": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useShutdownOnUserLogoff": true,
    "shutdownOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ]
  }
}

Get

get

Retrieves FSLogix Office Container User Inclusion List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Office Container settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Get

get

Retrieves the FSLogix Office Container settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Office Container settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/OfficeContainer HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "advancedSettings": {
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useIncludeOfficeActivation": true,
    "includeOfficeActivation": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneDrive": true,
    "includeOneDrive": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNote": true,
    "includeOneNote": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNoteUWP": true,
    "includeOneNoteUWP": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlook": true,
    "includeOutlook": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlookPersonalization": true,
    "includeOutlookPersonalization": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSharepoint": true,
    "includeSharepoint": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSkype": true,
    "includeSkype": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeTeams": true,
    "includeTeams": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMirrorLocalOSTToVHD": true,
    "mirrorLocalOSTToVHD": [
      "0 = DoNothing",
      "1 = Copy",
      "2 = Move"
    ],
    "useNumSessionVHDsToKeep": true,
    "numSessionVHDsToKeep": 1,
    "useOutlookFolderPath": true,
    "outlookFolderPath": "text",
    "useRefreshUserPolicy": true,
    "refreshUserPolicy": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDAccessMode": true,
    "vhdAccessMode": [
      "0 = NormalDirectAccess",
      "1 = DiffDiskNetwork",
      "2 = DiffDiskLocal",
      "3 = UniqueVHDPerSession"
    ]
  }
}

Get

get

Retrieves FSLogix Office Container CCDLocation List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Office Container settings.

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

List

get

Retrieve information about one or multiple Schedule setting.

Query parameters

SiteIdinteger · int32Optional

Site ID from which to retrieve the Schedule setting (optional).

NamestringOptional

The name of the Schedule setting for which to retrieve the information. This must be the actual Schedule setting name used in the RAS connections.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/Schedule HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "siteID": 1,
    "objType": [
      "44 = RDS",
      "92 = AVD",
      "100 = VDI"
    ],
    "action": [
      "0 = Disable",
      "1 = Reboot",
      "3 = Startup",
      "4 = Shutdown",
      "7 = Recreate"
    ],
    "targetType": [
      "0 = Host",
      "1 = HostPool"
    ],
    "enabled": true,
    "name": "text",
    "description": "text",
    "type": 1,
    "targetIDs": [
      1
    ],
    "targetNativeHosts": [
      {
        "poolId": 1,
        "guid": "text",
        "guestName": "text",
        "hostAzureID": "text"
      }
    ],
    "trigger": {
      "startDateTime": "2025-05-09T04:40:27.458Z",
      "endDateTime": "2025-05-09T04:40:27.458Z",
      "repeat": [
        "0 = Never",
        "1 = EveryDay",
        "2 = EveryWeek",
        "3 = Every2Weeks",
        "4 = EveryMonth",
        "5 = EveryYear",
        "6 = SpecificDays"
      ],
      "specificDays": [
        "0 = Never",
        "1 = Sunday",
        "2 = Monday",
        "4 = Tuesday",
        "8 = Wednesday",
        "16 = Thursday",
        "32 = Friday",
        "64 = Saturday"
      ],
      "durationInSecs": 1,
      "completeIn": 1
    },
    "options": {
      "poolMembersType": 1,
      "percentageMembers": 1,
      "membersToStart": 1,
      "powerOnAssignedPoolMembers": 1,
      "messages": [
        {
          "id": 1,
          "enabled": true,
          "messageTitle": "text",
          "message": "text",
          "sendMsgSecs": 1,
          "sendMsgWhen": [
            "0 = Before",
            "1 = After"
          ]
        }
      ],
      "enableDrainMode": true,
      "forceServerRebootAfter": 1,
      "enforceScheduleInactiveHost": true,
      "onDisable": true
    }
  }
]

Get

get

Retrieve information about a particular Schedule setting by ID.

Path parameters

Idinteger · int32Required

The ID of the Schedule setting for which to retrieve the information.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "endDateTime": "2025-05-09T04:40:27.458Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Delete

delete

Remove a Schedule setting.

Path parameters

Idinteger · int32Required

The ID of a Schedule setting to remove.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

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

No content

Get

get

Retrieve FSLogix Profile Container VHDLocation List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieve FSLogix Profile Container CCDLocation List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieve FSLogix Profile Container Folder Exclusion List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieve FSLogix Profile Container Folder Inclusion List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieves FSLogix Office Container VHDLocation List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Office Container settings.

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieve FSLogix Profile Container User Exclusion List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Get

get

Retrieve FSLogix Profile Container User Inclusion List of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to retrieve the FSLogix Profile Container settings.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

List

get

Retrieve a list of AVD predefined vm images.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

[
  {
    "imageSessionType": [
      "0 = SingleSession",
      "1 = MultiSession"
    ],
    "displayName": "text",
    "publisher": "text",
    "offer": "text",
    "sku": "text"
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Provider Locations.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Location.

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/Location HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "displayName": "text",
    "resourceType": [
      "0 = NotFound",
      "64 = AVDWorkspace",
      "87 = AVDProvider",
      "2023 = AVDResourceGroup"
    ]
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Offer.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the Azure Virtual Desktop Offer.

locationstringOptional

The Azure Virtual Desktop Location of the Azure Virtual Desktop Offer.

publisherstringOptional

The Azure Virtual Desktop Publisher of the Azure Virtual Desktop Offer.

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/Offer HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "azureId": "text"
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Publishers.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Publishers.

locationstringOptional

The Azure Virtual Desktop Location of the Azure Virtual Desktop Publishers.

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/Publisher HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "azureId": "text"
  }
]

Get

get

Retrieve the Azure Virtual Desktop Feature Site Settings.

Query parameters

siteIdinteger · int32Optional

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

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/Settings HTTP/1.1
Host: 
Accept: */*

{
  "siteId": 1,
  "enabled": true,
  "clientFeatureSet": [
    "0 = Standard",
    "1 = Advanced",
    "2 = AdvancedWithFallback"
  ],
  "replicate": true
}

List

get

Retrieve settings about RAS Templates.

Query parameters

SiteIdinteger · int32Optional

The site ID from which to retrieve the RAS Template info (optional).

NamestringOptional

RAS Template name.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

[
  {
    "id": 1,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "objType": [
      "89 = AVDTemplate",
      "101 = RDSTemplate",
      "102 = VDITemplate"
    ],
    "name": "text",
    "siteId": 1,
    "description": "text",
    "providerId": 1,
    "templateType": [
      "0 = SingleSession",
      "1 = MultiSession"
    ],
    "vmId": "text",
    "cloneMethod": [
      "0 = FullClone",
      "1 = LinkedClone"
    ],
    "advanced": {
      "folder": {
        "folderName": "text",
        "folderId": "text",
        "subFolderName": "text"
      },
      "nativePool": {
        "nativePoolId": "text",
        "nativePoolName": "text",
        "hwgpu": true
      },
      "physicalHost": {
        "physicalHostId": "text",
        "physicalHostName": "text"
      },
      "multipleNIC": {
        "useSeperateNetworkInterface": true,
        "address": "text",
        "subnetMask": "text"
      },
      "aws": {
        "instanceType": "text",
        "storageDevices": [
          {
            "deviceName": "text",
            "volumeType": [
              "0 = gp2",
              "1 = gp3",
              "2 = io1",
              "3 = io2",
              "4 = standard"
            ],
            "size": 1,
            "maximumIOPS": 1,
            "throughput": 1
          }
        ]
      },
      "azure": {
        "resourceGroup": "text",
        "location": "text",
        "vmSize": "text",
        "osDiskType": [
          "1 = StandardHDD",
          "2 = StandardSSD",
          "4 = PremiumSSD"
        ],
        "virtualNetworkID": "text",
        "virtualNetworkName": "text",
        "subnet": {
          "subnetID": "text",
          "subnetName": "text"
        }
      }
    },
    "preparation": {
      "imagePrepTool": [
        "0 = SysPrep",
        "1 = RASPrep"
      ],
      "computerName": "text",
      "ownerName": "text",
      "organization": "text",
      "administrator": "text",
      "domain": "text",
      "domainOrgUnit": "text"
    },
    "inheritDefaultOptimizationSettings": true,
    "optimization": {
      "enableOptimization": true,
      "optimizationType": [
        "0 = Automatic",
        "1 = Manual"
      ],
      "windowsDefenderATP": {
        "winDefATPTurnOffOn": [
          "0 = TurnOffWindowsDefenderATP",
          "1 = TurnOnWindowsDefenderATP"
        ],
        "disableRealTimeProtection": true,
        "excludeFolders": [
          "text"
        ],
        "excludeProcesses": [
          "text"
        ],
        "excludeExtension": [
          "text"
        ]
      },
      "windowsComponents": {
        "windowsComponentsList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "componentName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsDefenderATPEnabled": true,
      "windowsComponentsEnabled": true,
      "windowsServicesEnabled": true,
      "windowsScheduledTasksEnabled": true,
      "windowsAdvancedOptionsEnabled": true,
      "networkPerformanceEnabled": true,
      "registryEnabled": true,
      "visualEffectsEnabled": true,
      "diskCleanupEnabled": true,
      "customScriptEnabled": true,
      "windowsServices": {
        "windowsServicesList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "serviceName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsAdvancedOptions": {
        "partialStartLayoutContent": "text",
        "hibernate": true,
        "teleCollection": true,
        "systemRestore": true,
        "additionalErrorReport": true,
        "tiles": true,
        "cortana": true,
        "microsoftConsumerExperience": true,
        "windowsTips": true,
        "commonProgramGroups": true,
        "partialStartMenu": true
      },
      "networkPerformance": {
        "dirCacheMax": 1,
        "dormantFileLimit": 1,
        "fileNotFoundCache": 1,
        "fileInfoCache": 1,
        "fileInfoCacheEnable": true,
        "directoryCacheEnable": true,
        "fileNotFoundCacheEnable": true,
        "dormantFileLimitEnable": true,
        "disableTCP": true,
        "disableIPv6CompEnable": true,
        "disableIPv6ToIPv4": true,
        "disableIsaTap": true
      },
      "customScript": {
        "arguments": "text",
        "command": "text",
        "initDir": "text",
        "user": "text"
      },
      "diskCleanup": {
        "cleanupWinSxSFolder": true,
        "cleanupSystemFiles": true,
        "cleanupTemporaryFileLogs": true,
        "removeOneDrive": true,
        "deleteUserProfiles": true
      },
      "visualEffects": {
        "visualEffectsTypes": [
          "0 = LetWindowsChooseWhatsBest",
          "1 = AdjustForBestAppearance",
          "2 = AdjustForBestPerformance",
          "3 = Custom"
        ],
        "animateControlSelectElements": true,
        "animateWindowsWhenMinimizingMaximizing": true,
        "animateTaskbar": true,
        "enablePeek": true,
        "fadeSlideMenus": true,
        "fadeSlideToolTips": true,
        "fadeOutMenuItems": true,
        "saveTaskbarThumbnail": true,
        "showShadowUnderMouse": true,
        "shadowUnderWindows": true,
        "thumbnailsInsteadOfIcons": true,
        "showTranslucentSelection": true,
        "showWindowsContentWhilstDragging": true,
        "slideOpenComboBoxes": true,
        "smoothEdgesScreenFonts": true,
        "smoothScrollListBoxes": true,
        "dropShadowsIcon": true
      },
      "windowsScheduledTasks": {
        "windowsScheduledTasksList": [
          {
            "task": "text",
            "location": "text",
            "type": [
              "0 = Folder",
              "1 = Task"
            ]
          }
        ]
      },
      "registry": {
        "registryList": [
          {
            "id": 1,
            "action": [
              "0 = Add",
              "1 = Modify",
              "2 = Delete"
            ],
            "registryName": "text",
            "dwordValue": 1,
            "displayName": "text",
            "hiveType": [
              "0 = HKEY_CURRENT_CONFIG",
              "1 = HKEY_USERS",
              "2 = HKEY_LOCAL_MACHINE",
              "3 = HKEY_CLASSES_ROOT"
            ],
            "path": "text",
            "regType": [
              "0 = REG_SZ",
              "1 = REG_DWORD",
              "2 = REG_QWORD",
              "3 = REG_MULTI_SZ",
              "4 = REG_EXPAND_SZ"
            ],
            "stringValue": "text"
          }
        ]
      },
      "uwpApps": {
        "allExcept": [
          "text"
        ],
        "followingPkgs": [
          "text"
        ],
        "removeType": [
          "0 = AllExcept",
          "1 = FollowingPkgs"
        ]
      }
    },
    "licenseKeys": {
      "licenseKeyType": [
        "0 = KMS",
        "1 = MAK"
      ],
      "keys": [
        {
          "licenseKey": "text",
          "keyLimit": 1
        }
      ]
    }
  }
]

Get

get

Retrieve settings of a RAS Template.

Path parameters

idinteger · int32Required

The ID of a RAS Template for which to retrieve the information.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "objType": [
    "89 = AVDTemplate",
    "101 = RDSTemplate",
    "102 = VDITemplate"
  ],
  "name": "text",
  "siteId": 1,
  "description": "text",
  "providerId": 1,
  "templateType": [
    "0 = SingleSession",
    "1 = MultiSession"
  ],
  "vmId": "text",
  "cloneMethod": [
    "0 = FullClone",
    "1 = LinkedClone"
  ],
  "advanced": {
    "folder": {
      "folderName": "text",
      "folderId": "text",
      "subFolderName": "text"
    },
    "nativePool": {
      "nativePoolId": "text",
      "nativePoolName": "text",
      "hwgpu": true
    },
    "physicalHost": {
      "physicalHostId": "text",
      "physicalHostName": "text"
    },
    "multipleNIC": {
      "useSeperateNetworkInterface": true,
      "address": "text",
      "subnetMask": "text"
    },
    "aws": {
      "instanceType": "text",
      "storageDevices": [
        {
          "deviceName": "text",
          "volumeType": [
            "0 = gp2",
            "1 = gp3",
            "2 = io1",
            "3 = io2",
            "4 = standard"
          ],
          "size": 1,
          "maximumIOPS": 1,
          "throughput": 1
        }
      ]
    },
    "azure": {
      "resourceGroup": "text",
      "location": "text",
      "vmSize": "text",
      "osDiskType": [
        "1 = StandardHDD",
        "2 = StandardSSD",
        "4 = PremiumSSD"
      ],
      "virtualNetworkID": "text",
      "virtualNetworkName": "text",
      "subnet": {
        "subnetID": "text",
        "subnetName": "text"
      }
    }
  },
  "preparation": {
    "imagePrepTool": [
      "0 = SysPrep",
      "1 = RASPrep"
    ],
    "computerName": "text",
    "ownerName": "text",
    "organization": "text",
    "administrator": "text",
    "domain": "text",
    "domainOrgUnit": "text"
  },
  "inheritDefaultOptimizationSettings": true,
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "licenseKeys": {
    "licenseKeyType": [
      "0 = KMS",
      "1 = MAK"
    ],
    "keys": [
      {
        "licenseKey": "text",
        "keyLimit": 1
      }
    ]
  }
}

Delete

delete

Remove settings of a RAS Template.

Path parameters

idinteger · int32Required

The ID of a RAS Template for which to retrieve the information.

Responses

204

No Content

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

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

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "objType": [
    "89 = AVDTemplate",
    "101 = RDSTemplate",
    "102 = VDITemplate"
  ],
  "name": "text",
  "siteId": 1,
  "description": "text",
  "providerId": 1,
  "templateType": [
    "0 = SingleSession",
    "1 = MultiSession"
  ],
  "vmId": "text",
  "cloneMethod": [
    "0 = FullClone",
    "1 = LinkedClone"
  ],
  "advanced": {
    "folder": {
      "folderName": "text",
      "folderId": "text",
      "subFolderName": "text"
    },
    "nativePool": {
      "nativePoolId": "text",
      "nativePoolName": "text",
      "hwgpu": true
    },
    "physicalHost": {
      "physicalHostId": "text",
      "physicalHostName": "text"
    },
    "multipleNIC": {
      "useSeperateNetworkInterface": true,
      "address": "text",
      "subnetMask": "text"
    },
    "aws": {
      "instanceType": "text",
      "storageDevices": [
        {
          "deviceName": "text",
          "volumeType": [
            "0 = gp2",
            "1 = gp3",
            "2 = io1",
            "3 = io2",
            "4 = standard"
          ],
          "size": 1,
          "maximumIOPS": 1,
          "throughput": 1
        }
      ]
    },
    "azure": {
      "resourceGroup": "text",
      "location": "text",
      "vmSize": "text",
      "osDiskType": [
        "1 = StandardHDD",
        "2 = StandardSSD",
        "4 = PremiumSSD"
      ],
      "virtualNetworkID": "text",
      "virtualNetworkName": "text",
      "subnet": {
        "subnetID": "text",
        "subnetName": "text"
      }
    }
  },
  "preparation": {
    "imagePrepTool": [
      "0 = SysPrep",
      "1 = RASPrep"
    ],
    "computerName": "text",
    "ownerName": "text",
    "organization": "text",
    "administrator": "text",
    "domain": "text",
    "domainOrgUnit": "text"
  },
  "inheritDefaultOptimizationSettings": true,
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "licenseKeys": {
    "licenseKeyType": [
      "0 = KMS",
      "1 = MAK"
    ],
    "keys": [
      {
        "licenseKey": "text",
        "keyLimit": 1
      }
    ]
  }
}

Enter Maintenance

post

Enter Maintenance Mode.

Path parameters

idinteger · int32Required

The ID of the target RAS Template.

Query parameters

forceStopUpdateDesktopsbooleanOptional

Force stopping/updating of desktop VMs.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/EnterMaintenance HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve Windows Component Custom

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the windows component custom list.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/{id}/Optimization/WindowsComponent HTTP/1.1
Host: 
Accept: */*

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "componentName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Resource Groups.

Path parameters

providerIdinteger · int32Required

The Provider ID for which to retrieve the list of Azure Virtual Desktop Resource Groups.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to retrieve the list of Azure Virtual Desktop Resource Groups (optional).

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/ResourceGroup/{providerId} HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "location": "text",
    "azureId": "text"
  }
]

List

get

Retrieves Registry.

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the registry.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/{id}/Optimization/Registry HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }
]

Exit Maintenance

post

Exit Maintenance Mode.

Path parameters

idinteger · int32Required

The ID of the target RAS Template.

Query parameters

forceStopUpdateDesktopsbooleanOptional

Force stopping/updating of desktop VMs.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/ExitMaintenance HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve a list of Azure Virtual Desktop SKU.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the Azure Virtual Desktop SKU.

locationstringOptional

The Azure Virtual Desktop Location of the Azure Virtual Desktop SKU.

publisherstringOptional

The Azure Virtual Desktop Publisher of the Azure Virtual Desktop SKU.

offerstringOptional

The Azure Virtual Desktop Offer of the Azure Virtual Desktop SKU.

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/SKU HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "azureId": "text"
  }
]

Get

get

Retrieve Image Optimization Settings

Path parameters

idinteger · int32Required

Retrieve the Image Optimization by id

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATP": {
    "winDefATPTurnOffOn": [
      "0 = TurnOffWindowsDefenderATP",
      "1 = TurnOnWindowsDefenderATP"
    ],
    "disableRealTimeProtection": true,
    "excludeFolders": [
      "text"
    ],
    "excludeProcesses": [
      "text"
    ],
    "excludeExtension": [
      "text"
    ]
  },
  "windowsComponents": {
    "windowsComponentsList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "componentName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "windowsServices": {
    "windowsServicesList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "serviceName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsAdvancedOptions": {
    "partialStartLayoutContent": "text",
    "hibernate": true,
    "teleCollection": true,
    "systemRestore": true,
    "additionalErrorReport": true,
    "tiles": true,
    "cortana": true,
    "microsoftConsumerExperience": true,
    "windowsTips": true,
    "commonProgramGroups": true,
    "partialStartMenu": true
  },
  "networkPerformance": {
    "dirCacheMax": 1,
    "dormantFileLimit": 1,
    "fileNotFoundCache": 1,
    "fileInfoCache": 1,
    "fileInfoCacheEnable": true,
    "directoryCacheEnable": true,
    "fileNotFoundCacheEnable": true,
    "dormantFileLimitEnable": true,
    "disableTCP": true,
    "disableIPv6CompEnable": true,
    "disableIPv6ToIPv4": true,
    "disableIsaTap": true
  },
  "customScript": {
    "arguments": "text",
    "command": "text",
    "initDir": "text",
    "user": "text"
  },
  "diskCleanup": {
    "cleanupWinSxSFolder": true,
    "cleanupSystemFiles": true,
    "cleanupTemporaryFileLogs": true,
    "removeOneDrive": true,
    "deleteUserProfiles": true
  },
  "visualEffects": {
    "visualEffectsTypes": [
      "0 = LetWindowsChooseWhatsBest",
      "1 = AdjustForBestAppearance",
      "2 = AdjustForBestPerformance",
      "3 = Custom"
    ],
    "animateControlSelectElements": true,
    "animateWindowsWhenMinimizingMaximizing": true,
    "animateTaskbar": true,
    "enablePeek": true,
    "fadeSlideMenus": true,
    "fadeSlideToolTips": true,
    "fadeOutMenuItems": true,
    "saveTaskbarThumbnail": true,
    "showShadowUnderMouse": true,
    "shadowUnderWindows": true,
    "thumbnailsInsteadOfIcons": true,
    "showTranslucentSelection": true,
    "showWindowsContentWhilstDragging": true,
    "slideOpenComboBoxes": true,
    "smoothEdgesScreenFonts": true,
    "smoothScrollListBoxes": true,
    "dropShadowsIcon": true
  },
  "windowsScheduledTasks": {
    "windowsScheduledTasksList": [
      {
        "task": "text",
        "location": "text",
        "type": [
          "0 = Folder",
          "1 = Task"
        ]
      }
    ]
  },
  "registry": {
    "registryList": [
      {
        "id": 1,
        "action": [
          "0 = Add",
          "1 = Modify",
          "2 = Delete"
        ],
        "registryName": "text",
        "dwordValue": 1,
        "displayName": "text",
        "hiveType": [
          "0 = HKEY_CURRENT_CONFIG",
          "1 = HKEY_USERS",
          "2 = HKEY_LOCAL_MACHINE",
          "3 = HKEY_CLASSES_ROOT"
        ],
        "path": "text",
        "regType": [
          "0 = REG_SZ",
          "1 = REG_DWORD",
          "2 = REG_QWORD",
          "3 = REG_MULTI_SZ",
          "4 = REG_EXPAND_SZ"
        ],
        "stringValue": "text"
      }
    ]
  },
  "uwpApps": {
    "allExcept": [
      "text"
    ],
    "followingPkgs": [
      "text"
    ],
    "removeType": [
      "0 = AllExcept",
      "1 = FollowingPkgs"
    ]
  }
}

Recreate Desktops

post

Recreate All Desktops or a specific Desktop.

Path parameters

idinteger · int32Required

The ID of the target RAS Template.

Query parameters

vdiDesktopIdstringOptional

The ID of a desktop VM to be recreated (optional).

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/RecreateDesktops HTTP/1.1
Host: 
Accept: */*

No content

List

get

Retrieve Windows Scheduled Task

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the windows scheduled task.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Accept: */*

[
  {
    "task": "text",
    "location": "text",
    "type": [
      "0 = Folder",
      "1 = Task"
    ]
  }
]

List

get

Retrieve a list of Azure Virtual Desktop Versions.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the Azure Virtual Desktop Version.

locationstringOptional

The Azure Virtual Desktop Location of the Azure Virtual Desktop Version.

publisherstringOptional

The Azure Virtual Desktop Publisher of the Azure Virtual Desktop Version.

offerstringOptional

The Azure Virtual Desktop Offer of the Azure Virtual Desktop Version.

skustringOptional

The Azure Virtual Desktop SKU of the Azure Virtual Desktop Version.

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/Version HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "azureId": "text"
  }
]

Get Versions By Name

get

Retrieve a list of template's versions.

Query parameters

SiteIdinteger · int32Optional

Site ID for which the template with version information will be retrieved (optional)

NamestringOptional

Filter the result by name (optional)

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/Version HTTP/1.1
Host: 
Accept: */*

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "name": "text",
    "id": 1,
    "templateId": 1,
    "description": "text"
  }
]

Get Versions

get

Retrieve a list of template's versions.

Path parameters

idinteger · int32Required

Template ID

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

[
  {
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2025-05-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "name": "text",
    "id": 1,
    "templateId": 1,
    "description": "text"
  }
]

Delete Version

delete

Remove settings of a RAS Template version.

Path parameters

idinteger · int32Required

The ID of a RAS Template

VersionIdinteger · int32Required

The ID of a RAS Template Version

Responses

204

No Content

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/Template/{id}/Version/{VersionId} HTTP/1.1
Host: 
Accept: */*

{
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "name": "text",
  "id": 1,
  "templateId": 1,
  "description": "text"
}

List

get

Retrieve a list of templates with status information.

Query parameters

SiteIdinteger · int32Optional

Site ID for which the template with status information will be retrieved (optional)

NamestringOptional

Filter the result by name (optional)

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/Status HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "siteId": 1,
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "name": "text",
    "providerId": 1,
    "desktopId": "text",
    "status": [
      "0 = Unknown",
      "1 = CreatingVM",
      "2 = CreateVMFailed",
      "3 = PushingAgent",
      "4 = PushAgentFailed",
      "5 = Configuring",
      "6 = ConfigureFailed",
      "7 = Converting",
      "8 = ConvertFailed",
      "9 = Creating",
      "10 = Created",
      "11 = Deleting",
      "12 = DeleteFailed",
      "13 = Deleted",
      "14 = Failed",
      "15 = EnteringMaintenance",
      "16 = ExitingMaintenance",
      "17 = Maintenance",
      "18 = CloningInProgress",
      "19 = NeedsUpdate",
      "20 = Broken",
      "21 = CreatingVersion"
    ],
    "powerState": [
      "0 = Unknown",
      "1 = PoweringOn",
      "2 = PoweredOn",
      "4 = PoweringOff",
      "8 = PoweredOff",
      "16 = Suspending",
      "32 = Suspended",
      "64 = FailedToCreate",
      "512 = Sysprep",
      "1024 = Cloning",
      "2048 = Deleting",
      "4096 = Rasprep",
      "4097 = Connected",
      "4098 = Disconnected"
    ],
    "agentVer": "text",
    "templateHasClones": true,
    "agentStatus": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "distribution": [
      "0 = Unknown",
      "1 = Distributing",
      "2 = DistributionFailed",
      "4 = OK",
      "8 = RemovingProvider",
      "16 = NeedsMigration",
      "32 = DeliveredFromSource",
      "64 = ReceivedByTarget",
      "128 = Deleting"
    ],
    "templateVMExist": true
  }
]

Get

get

Retrieve the template status information.

Path parameters

idinteger · int32Required

Template ID

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

{
  "id": "text",
  "siteId": 1,
  "agentState": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ],
  "serverType": [
    "1 = RDSHost",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = PA",
    "9 = Site",
    "16 = RDSGroup",
    "25 = HALBDevice",
    "45 = TenantBroker",
    "46 = Enrollment",
    "51 = HALB",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "95 = VDITemplateVersion",
    "96 = AVDTemplateVersion",
    "97 = RDSTemplateVersion",
    "107 = RDSTemplate",
    "108 = VDITemplate",
    "2013 = VDIHost",
    "-1 = All"
  ],
  "name": "text",
  "providerId": 1,
  "desktopId": "text",
  "status": [
    "0 = Unknown",
    "1 = CreatingVM",
    "2 = CreateVMFailed",
    "3 = PushingAgent",
    "4 = PushAgentFailed",
    "5 = Configuring",
    "6 = ConfigureFailed",
    "7 = Converting",
    "8 = ConvertFailed",
    "9 = Creating",
    "10 = Created",
    "11 = Deleting",
    "12 = DeleteFailed",
    "13 = Deleted",
    "14 = Failed",
    "15 = EnteringMaintenance",
    "16 = ExitingMaintenance",
    "17 = Maintenance",
    "18 = CloningInProgress",
    "19 = NeedsUpdate",
    "20 = Broken",
    "21 = CreatingVersion"
  ],
  "powerState": [
    "0 = Unknown",
    "1 = PoweringOn",
    "2 = PoweredOn",
    "4 = PoweringOff",
    "8 = PoweredOff",
    "16 = Suspending",
    "32 = Suspended",
    "64 = FailedToCreate",
    "512 = Sysprep",
    "1024 = Cloning",
    "2048 = Deleting",
    "4096 = Rasprep",
    "4097 = Connected",
    "4098 = Disconnected"
  ],
  "agentVer": "text",
  "templateHasClones": true,
  "agentStatus": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ],
  "distribution": [
    "0 = Unknown",
    "1 = Distributing",
    "2 = DistributionFailed",
    "4 = OK",
    "8 = RemovingProvider",
    "16 = NeedsMigration",
    "32 = DeliveredFromSource",
    "64 = ReceivedByTarget",
    "128 = Deleting"
  ],
  "templateVMExist": true
}

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-09T04:40:27.458Z",
    "timeLastMod": "2025-05-09T04:40:27.458Z",
    "providerId": 1,
    "name": "text",
    "enabled": true,
    "friendlyName": "text",
    "description": "text",
    "resourceGroup": "text",
    "location": "text",
    "azureId": "text"
  }
]

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-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "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 Virtual Networks.

Query parameters

providerIdinteger · int32Optional

The Provider ID for which to retrieve the list of Azure Virtual Desktop Virtual Networks.

locationstringOptional

The Azure Virtual Desktop Location of the Azure Virtual Desktop Virtual Networks.

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/VirtualNetwork HTTP/1.1
Host: 
Accept: */*

[
  {
    "name": "text",
    "subnets": [
      {
        "name": "text",
        "addressPrefix": "text",
        "azureId": "text"
      }
    ],
    "azureId": "text"
  }
]

List

get

Retrieves a list of AVD Workspaces status information.

Query parameters

SiteIdinteger · int32Optional

The site ID for which to retrieve all the AVD Workspace status information (optional)

NamestringOptional

Filter the result by Workspace name (optional)

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/status HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": "text",
    "siteId": 1,
    "serverType": [
      "1 = RDSHost",
      "2 = Provider",
      "3 = Gateway",
      "4 = Guest",
      "7 = PA",
      "9 = Site",
      "16 = RDSGroup",
      "25 = HALBDevice",
      "45 = TenantBroker",
      "46 = Enrollment",
      "51 = HALB",
      "64 = AVDWorkspace",
      "65 = AVDHostPool",
      "66 = AVDTemplate",
      "67 = AVDHost",
      "95 = VDITemplateVersion",
      "96 = AVDTemplateVersion",
      "97 = RDSTemplateVersion",
      "107 = RDSTemplate",
      "108 = VDITemplate",
      "2013 = VDIHost",
      "-1 = All"
    ],
    "name": "text",
    "providerId": 1,
    "resourceGroup": "text",
    "location": "text",
    "agentState": [
      "0 = OK",
      "1 = EnumSessionsFailed",
      "2 = RDSRoleDisabled",
      "3 = MaxNonCompletedSessions",
      "4 = RASScheduleInProgress",
      "5 = ConnectionFailed",
      "6 = InvalidCredentials",
      "7 = NeedsSysprep",
      "8 = SysPrepInProgress",
      "9 = CloningFailed",
      "10 = Synchronising",
      "13 = LogonDrainUntilRestart",
      "14 = LogonDrain",
      "15 = LogonDisabled",
      "16 = ForcedDisconnect",
      "17 = CloningCanceled",
      "18 = RASprepInProgress",
      "20 = InstallingRDSRole",
      "21 = RebootPending",
      "22 = PortMismatch",
      "23 = NeedsDowngrade",
      "24 = NotApplied",
      "25 = CloningInProgress",
      "26 = MarkedForDeletion",
      "27 = StandBy",
      "28 = UnsupportedVDIType",
      "29 = FreeESXLicenseNotSupported",
      "30 = ManagedESXNotSupported",
      "32 = InvalidHostVersion",
      "33 = NotJoined",
      "35 = LicenseExpired",
      "36 = JoinBroken",
      "37 = InUse",
      "38 = NotInUse",
      "39 = Unsupported",
      "40 = NoAvailableGateways",
      "41 = EnrollServerNotInitialized",
      "42 = EnrollmentUnavailable",
      "43 = InvalidCAConfig",
      "44 = InvalidEAUserCredentials",
      "45 = InvalidESSettings",
      "46 = FSLogixNotAvail",
      "47 = NoDevices",
      "48 = NeedsAttention",
      "49 = ImageOptimizationPending",
      "50 = ImageOptimization",
      "51 = Unavailable",
      "52 = UnderConstruction",
      "53 = Broken",
      "54 = NonRAS",
      "55 = Provisioning",
      "56 = Invalid",
      "57 = FSLogixNeedsUpdate",
      "58 = NoMembersAvailable",
      "59 = MembersNeedUpdate",
      "60 = FailedPerfCounters",
      "61 = PendingRecreation",
      "62 = RemovingMembers",
      "63 = AddingMembers",
      "64 = DeleteInProgress",
      "66 = JoiningToHostPool",
      "67 = AutoUpgradeInProgress",
      "68 = AutoUpgradeInitiated",
      "-8 = AutoUpgradeLimitReached",
      "-7 = AutoUpgradeFailed",
      "-6 = Unknown",
      "-5 = NeedsUpdate",
      "-4 = NotVerified",
      "-3 = ServerDeleted",
      "-2 = DisabledFromSettings",
      "-1 = Disconnected"
    ],
    "brokenReason": [
      "0 = MissingObj",
      "1 = InvalidTags",
      "2 = MissingDAGObj",
      "3 = InvalidDAGTags",
      "4 = MissingDAGRoles",
      "5 = MissingDAGWorkspaceLink",
      "6 = HostpoolAutomaticAssignment",
      "7 = MissingRAGObj",
      "8 = InvalidRAGTags",
      "9 = MissingRAGRoles",
      "10 = MissingRAGWorkspaceLink",
      "11 = MissingRAGRemoteApp",
      "12 = MissingObjectID",
      "-1 = Ignore"
    ]
  }
]

Get

get

Retrieve the AVD Workspace status information.

Path parameters

idinteger · int32Required

AVD Workspace ID

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}/status HTTP/1.1
Host: 
Accept: */*

{
  "id": "text",
  "siteId": 1,
  "serverType": [
    "1 = RDSHost",
    "2 = Provider",
    "3 = Gateway",
    "4 = Guest",
    "7 = PA",
    "9 = Site",
    "16 = RDSGroup",
    "25 = HALBDevice",
    "45 = TenantBroker",
    "46 = Enrollment",
    "51 = HALB",
    "64 = AVDWorkspace",
    "65 = AVDHostPool",
    "66 = AVDTemplate",
    "67 = AVDHost",
    "95 = VDITemplateVersion",
    "96 = AVDTemplateVersion",
    "97 = RDSTemplateVersion",
    "107 = RDSTemplate",
    "108 = VDITemplate",
    "2013 = VDIHost",
    "-1 = All"
  ],
  "name": "text",
  "providerId": 1,
  "resourceGroup": "text",
  "location": "text",
  "agentState": [
    "0 = OK",
    "1 = EnumSessionsFailed",
    "2 = RDSRoleDisabled",
    "3 = MaxNonCompletedSessions",
    "4 = RASScheduleInProgress",
    "5 = ConnectionFailed",
    "6 = InvalidCredentials",
    "7 = NeedsSysprep",
    "8 = SysPrepInProgress",
    "9 = CloningFailed",
    "10 = Synchronising",
    "13 = LogonDrainUntilRestart",
    "14 = LogonDrain",
    "15 = LogonDisabled",
    "16 = ForcedDisconnect",
    "17 = CloningCanceled",
    "18 = RASprepInProgress",
    "20 = InstallingRDSRole",
    "21 = RebootPending",
    "22 = PortMismatch",
    "23 = NeedsDowngrade",
    "24 = NotApplied",
    "25 = CloningInProgress",
    "26 = MarkedForDeletion",
    "27 = StandBy",
    "28 = UnsupportedVDIType",
    "29 = FreeESXLicenseNotSupported",
    "30 = ManagedESXNotSupported",
    "32 = InvalidHostVersion",
    "33 = NotJoined",
    "35 = LicenseExpired",
    "36 = JoinBroken",
    "37 = InUse",
    "38 = NotInUse",
    "39 = Unsupported",
    "40 = NoAvailableGateways",
    "41 = EnrollServerNotInitialized",
    "42 = EnrollmentUnavailable",
    "43 = InvalidCAConfig",
    "44 = InvalidEAUserCredentials",
    "45 = InvalidESSettings",
    "46 = FSLogixNotAvail",
    "47 = NoDevices",
    "48 = NeedsAttention",
    "49 = ImageOptimizationPending",
    "50 = ImageOptimization",
    "51 = Unavailable",
    "52 = UnderConstruction",
    "53 = Broken",
    "54 = NonRAS",
    "55 = Provisioning",
    "56 = Invalid",
    "57 = FSLogixNeedsUpdate",
    "58 = NoMembersAvailable",
    "59 = MembersNeedUpdate",
    "60 = FailedPerfCounters",
    "61 = PendingRecreation",
    "62 = RemovingMembers",
    "63 = AddingMembers",
    "64 = DeleteInProgress",
    "66 = JoiningToHostPool",
    "67 = AutoUpgradeInProgress",
    "68 = AutoUpgradeInitiated",
    "-8 = AutoUpgradeLimitReached",
    "-7 = AutoUpgradeFailed",
    "-6 = Unknown",
    "-5 = NeedsUpdate",
    "-4 = NotVerified",
    "-3 = ServerDeleted",
    "-2 = DisabledFromSettings",
    "-1 = Disconnected"
  ],
  "brokenReason": [
    "0 = MissingObj",
    "1 = InvalidTags",
    "2 = MissingDAGObj",
    "3 = InvalidDAGTags",
    "4 = MissingDAGRoles",
    "5 = MissingDAGWorkspaceLink",
    "6 = HostpoolAutomaticAssignment",
    "7 = MissingRAGObj",
    "8 = InvalidRAGTags",
    "9 = MissingRAGRoles",
    "10 = MissingRAGWorkspaceLink",
    "11 = MissingRAGRemoteApp",
    "12 = MissingObjectID",
    "-1 = Ignore"
  ]
}

Get

get

Retrieve the Azure Virtaul Desktop Default settings.

Query parameters

SiteIdinteger · int32Optional

Site ID for which to retrieve Azure Virtual Desktop Default settings (optional)

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/DefaultSettings/MultiSession HTTP/1.1
Host: 
Accept: */*

{
  "siteId": 1,
  "defObjType": [
    "71 = AVDMultiSessionDefaultSettings",
    "72 = AVDSingleSessionDefaultSettings"
  ],
  "agent": {
    "disconnectActiveSessionAfter": 1,
    "logoffDisconnectedSessionAfter": 1,
    "sessionReadinessTimeout": 1,
    "allowURLAndMailRedirection": [
      "0 = Disabled",
      "1 = Enabled",
      "2 = EnabledWithAppRegistration"
    ],
    "supportShellURLNamespaceObjects": true,
    "dragAndDropMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "allowRemoteExec": true,
    "manageRDPTransportProtocol": [
      "0 = Disabled",
      "1 = BothUDPTCP",
      "2 = OnlyTCP",
      "3 = EitherUDPTCP"
    ],
    "fileTransferMode": [
      "0 = Disabled",
      "1 = ClientToServer",
      "2 = ServerToClient",
      "3 = Bidirectional"
    ],
    "fileTransferLocation": "text",
    "fileTransferLockLocation": true,
    "enableDriveRedirectionCache": true,
    "manageRDPShortpath": true,
    "appMonitor": true,
    "useRDPShortpath": true,
    "useSmallerPortRange": true,
    "minRDPShortpathPort": 1,
    "maxRDPShortpathPort": 1
  },
  "userProfile": {
    "technology": [
      "0 = DoNotManage",
      "1 = UPD",
      "2 = FSLogix"
    ],
    "fsLogix": {
      "profileContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "customizeProfileFolders": true,
        "excludeCommonFolders": [
          "1 = Contacts",
          "2 = Desktop",
          "4 = Documents",
          "8 = Links",
          "16 = MusicPodcasts",
          "32 = PicturesVideos",
          "64 = FoldersLowIntegProcesses",
          "128 = Downloads"
        ],
        "folderInclusionList": [
          "text"
        ],
        "folderExclusionList": [
          {
            "folder": "text",
            "excludeFolderCopy": [
              "0 = None",
              "1 = CopyBase",
              "2 = CopyBack"
            ]
          }
        ],
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useKeepLocalDir": true,
          "keepLocalDir": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useDeleteLocalProfileWhenVHDShouldApply": true,
          "deleteLocalProfileWhenVHDShouldApply": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useProfileDirSDDL": true,
          "profileDirSDDL": "text",
          "useProfileType": true,
          "profileType": [
            "0 = NormalProfile",
            "1 = OnlyRWProfile",
            "2 = OnlyROProfile",
            "3 = RWROProfile"
          ],
          "useSetTempToLocalPath": true,
          "setTempToLocalPath": [
            "0 = TakeNoAction",
            "1 = RedirectTempAndTmp",
            "2 = RedirectINetCache",
            "3 = RedirectTempTmpAndINetCache"
          ],
          "useCleanOutNotifications": true,
          "cleanOutNotifications": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useInstallAppxPackages": true,
          "installAppxPackages": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRebootOnUserLogoff": true,
          "rebootOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamIdentity": true,
          "roamIdentity": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useShutdownOnUserLogoff": true,
          "shutdownOnUserLogoff": [
            "0 = Disable",
            "1 = Enable"
          ]
        }
      },
      "officeContainer": {
        "enabled": true,
        "locationType": [
          "0 = SMBLocation",
          "1 = CloudCache"
        ],
        "vhdLocations": [
          "text"
        ],
        "ccdLocations": [
          "text"
        ],
        "profileDiskFormat": [
          "0 = VHD",
          "1 = VHDX"
        ],
        "allocationType": [
          "0 = Dynamic",
          "1 = Full"
        ],
        "defaultSize": 1,
        "userInclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "userExclusionList": [
          {
            "account": "text",
            "type": [
              "1 = User",
              "2 = Group",
              "3 = ForeignSecurityPrincipal",
              "4 = Computer"
            ],
            "sid": "text"
          }
        ],
        "cloudCache": {
          "useMaxCacheSizeInMBs": true,
          "maxCacheSizeInMBs": 1,
          "useClearCacheOnLogoff": true,
          "clearCacheOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useHealthyProvidersRequiredForRegister": true,
          "healthyProvidersRequiredForRegister": 1,
          "useHealthyProvidersRequiredForUnregister": true,
          "healthyProvidersRequiredForUnregister": 1,
          "useUnregisterTimeout": true,
          "unregisterTimeout": 1,
          "useClearCacheOnForcedUnregister": true,
          "clearCacheOnForcedUnregister": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "advancedSettings": {
          "useLockedRetryCount": true,
          "lockedRetryCount": 1,
          "useLockedRetryInterval": true,
          "lockedRetryInterval": 1,
          "useAccessNetworkAsComputerObject": true,
          "accessNetworkAsComputerObject": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useAttachVHDSDDL": true,
          "attachVHDSDDL": "text",
          "useDiffDiskParentFolderPath": true,
          "diffDiskParentFolderPath": "text",
          "useFlipFlopProfileDirectoryName": true,
          "flipFlopProfileDirectoryName": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useNoProfileContainingFolder": true,
          "noProfileContainingFolder": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useOutlookCachedMode": true,
          "outlookCachedMode": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithFailure": true,
          "preventLoginWithFailure": [
            "0 = Disable",
            "1 = Enable"
          ],
          "usePreventLoginWithTempProfile": true,
          "preventLoginWithTempProfile": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useReAttachRetryCount": true,
          "reAttachRetryCount": 1,
          "useReAttachIntervalSeconds": true,
          "reAttachIntervalSeconds": 1,
          "useRemoveOrphanedOSTFilesOnLogoff": true,
          "removeOrphanedOSTFilesOnLogoff": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamSearch": true,
          "roamSearch": [
            "0 = Disable",
            "1 = SingleUser",
            "2 = MultiUser"
          ],
          "useSIDDirNameMatch": true,
          "sidDirNameMatch": "text",
          "useSIDDirNamePattern": true,
          "sidDirNamePattern": "text",
          "useSIDDirSDDL": true,
          "sidDirSDDL": "text",
          "useVHDNameMatch": true,
          "vhdNameMatch": "text",
          "useVHDNamePattern": true,
          "vhdNamePattern": "text",
          "useVHDXSectorSize": true,
          "vhdxSectorSize": [
            "0 = SystemDefault",
            "512 = Size_512",
            "4096 = Size_4096"
          ],
          "useVolumeWaitTimeMS": true,
          "volumeWaitTimeMS": 1,
          "useIgnoreNonAVD": true,
          "ignoreNonAVD": [
            "0 = AnySession",
            "1 = AVDSessions"
          ],
          "useRedirectType": true,
          "redirectType": [
            "1 = Legacy",
            "2 = Advanced"
          ],
          "useIncludeOfficeActivation": true,
          "includeOfficeActivation": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneDrive": true,
          "includeOneDrive": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNote": true,
          "includeOneNote": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOneNoteUWP": true,
          "includeOneNoteUWP": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlook": true,
          "includeOutlook": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeOutlookPersonalization": true,
          "includeOutlookPersonalization": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSharepoint": true,
          "includeSharepoint": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeSkype": true,
          "includeSkype": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useIncludeTeams": true,
          "includeTeams": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useMirrorLocalOSTToVHD": true,
          "mirrorLocalOSTToVHD": [
            "0 = DoNothing",
            "1 = Copy",
            "2 = Move"
          ],
          "useNumSessionVHDsToKeep": true,
          "numSessionVHDsToKeep": 1,
          "useOutlookFolderPath": true,
          "outlookFolderPath": "text",
          "useRefreshUserPolicy": true,
          "refreshUserPolicy": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDAccessMode": true,
          "vhdAccessMode": [
            "0 = NormalDirectAccess",
            "1 = DiffDiskNetwork",
            "2 = DiffDiskLocal",
            "3 = UniqueVHDPerSession"
          ]
        }
      },
      "generalSettings": {
        "appServices": {
          "useCleanupInvalidSessions": true,
          "cleanupInvalidSessions": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useRoamRecycleBin": true,
          "roamRecycleBin": [
            "0 = Disable",
            "1 = Enable"
          ],
          "useVHDCompactDisk": true,
          "vhdCompactDisk": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "cloudCacheGeneral": {
          "useCacheDirectory": true,
          "cacheDirectory": "text",
          "useWriteCacheDirectory": true,
          "writeCacheDirectory": "text",
          "useProxyDirectory": true,
          "proxyDirectory": "text",
          "useSilenceACLWarning": true,
          "silenceACLWarning": [
            "0 = Disable",
            "1 = Enable"
          ]
        },
        "logging": {
          "logEnabled": [
            "0 = Disable",
            "1 = Specific",
            "2 = All"
          ],
          "logLevel": [
            "0 = Debug",
            "1 = Information",
            "2 = Warning",
            "3 = Error"
          ],
          "logFileKeepingPeriod": 1,
          "logDirectory": "text",
          "robocopyLogPath": "text",
          "logSpecificComponents": [
            "1 = ProfileConfigTool",
            "2 = IEPlugin",
            "4 = RuleEditor",
            "8 = JavaRuleEditor",
            "16 = FSLogixAgentService",
            "32 = Profile",
            "64 = JavaLauncher",
            "128 = OfficeContainer",
            "256 = RuleCompilation",
            "512 = FontVisibility",
            "1024 = Network",
            "2048 = PrinterVisibility",
            "4096 = ADSComputerGroup",
            "8192 = DriverInterface",
            "16384 = WindowsSearchRoaming",
            "32768 = WindowsSearchPlugin",
            "65536 = ProcessStartMonitor"
          ]
        }
      }
    }
  },
  "appPackagesAssigned": {
    "applicationPackagesAssigned": [
      {
        "version": "text",
        "tagName": "text",
        "tagId": 1,
        "packageName": "text"
      }
    ]
  },
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "action": {
    "sessionAction": [
      "0 = Disconnect",
      "1 = Logoff"
    ],
    "performAction": [
      "0 = DoNothing",
      "2 = Shutdown",
      "4 = Suspend",
      "7 = Delete",
      "8 = Restart",
      "9 = Unassign",
      "10 = Recreate"
    ],
    "performActionAfterSec": 1
  },
  "rdpPrinter": {
    "printerNameFormat": [
      "0 = PrnFormat_PRN_CMP_SES",
      "1 = PrnFormat_SES_CMP_PRN",
      "2 = PrnFormat_PRN_REDSES"
    ],
    "removeSessionNumberFromPrinterName": true,
    "removeClientNameFromPrinterName": true
  },
  "autoUpgrade": {
    "enabled": true,
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "drainModeDurationInSecs": 1,
    "forceLogoffSessions": true,
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ]
  }
}

List

get

Retrieve default Registry.

Query parameters

siteidinteger · int32Optional

The Site Id of the optimization setting to retrieve the registry.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/Optimization/Registry HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "action": [
      "0 = Add",
      "1 = Modify",
      "2 = Delete"
    ],
    "registryName": "text",
    "dwordValue": 1,
    "displayName": "text",
    "hiveType": [
      "0 = HKEY_CURRENT_CONFIG",
      "1 = HKEY_USERS",
      "2 = HKEY_LOCAL_MACHINE",
      "3 = HKEY_CLASSES_ROOT"
    ],
    "path": "text",
    "regType": [
      "0 = REG_SZ",
      "1 = REG_DWORD",
      "2 = REG_QWORD",
      "3 = REG_MULTI_SZ",
      "4 = REG_EXPAND_SZ"
    ],
    "stringValue": "text"
  }
]

List

get

Retrieve Default Windows Custom Component

Query parameters

siteIDinteger · int32Optional

The Site ID of the optimization setting to retrieve the windows component custom list.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsComponent HTTP/1.1
Host: 
Accept: */*

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "componentName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

List

get

Retrieve Default Windows Service Custom

Query parameters

siteIDinteger · int32Optional

The Site ID of the optimization setting to retrieve the windows service custom list.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsService HTTP/1.1
Host: 
Accept: */*

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "serviceName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Get Version Status

get

Retrieve a status of a template version.

Path parameters

VersionIdinteger · int32Required

Template Version ID

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/VersionStatus/{VersionId} HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "agentVersion": "text",
    "parentID": 1,
    "status": [
      "0 = NotCreated",
      "1 = Creating",
      "2 = OK",
      "3 = FailedToCreate",
      "4 = Deleting",
      "5 = DeletionPending",
      "6 = DeletingClones",
      "-1 = Unknown"
    ],
    "templateID": 1,
    "versionType": 1
  }
]

Get Version Status List By Template ID

get

Retrieve a list of a template's version statuses.

Path parameters

idinteger · int32Required

Template ID

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

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

[
  {
    "id": 1,
    "agentVersion": "text",
    "parentID": 1,
    "status": [
      "0 = NotCreated",
      "1 = Creating",
      "2 = OK",
      "3 = FailedToCreate",
      "4 = Deleting",
      "5 = DeletionPending",
      "6 = DeletingClones",
      "-1 = Unknown"
    ],
    "templateID": 1,
    "versionType": 1
  }
]

Get

get

Retrieve the Auto-upgrade settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the Auto-upgrade settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/AutoUpgrade HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "drainModeDurationInSecs": 1,
  "forceLogoffSessions": true,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "messages": [
    {
      "id": 1,
      "enabled": true,
      "messageTitle": "text",
      "message": "text",
      "sendMsgSecs": 1,
      "sendMsgWhen": [
        "0 = Before",
        "1 = After"
      ]
    }
  ]
}

Get

get

Retrieve the default assigned application package settings by Site ID.

Query parameters

siteIdinteger · int32Optional

The Site ID of the default assigned application package.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/AppPackageAssigned HTTP/1.1
Host: 
Accept: */*

[
  {
    "version": "text",
    "tagName": "text",
    "tagId": 1,
    "packageName": "text"
  }
]

Get

get

Retrieve the default image optimization settings by Site Id.

Query parameters

siteIdinteger · int32Optional

The Site Id of the default image optimization

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/Optimization HTTP/1.1
Host: 
Accept: */*

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATP": {
    "winDefATPTurnOffOn": [
      "0 = TurnOffWindowsDefenderATP",
      "1 = TurnOnWindowsDefenderATP"
    ],
    "disableRealTimeProtection": true,
    "excludeFolders": [
      "text"
    ],
    "excludeProcesses": [
      "text"
    ],
    "excludeExtension": [
      "text"
    ]
  },
  "windowsComponents": {
    "windowsComponentsList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "componentName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "windowsServices": {
    "windowsServicesList": [
      {
        "type": [
          "0 = Predefined",
          "1 = Custom"
        ],
        "serviceName": "text",
        "displayName": "text",
        "aliases": "text"
      }
    ]
  },
  "windowsAdvancedOptions": {
    "partialStartLayoutContent": "text",
    "hibernate": true,
    "teleCollection": true,
    "systemRestore": true,
    "additionalErrorReport": true,
    "tiles": true,
    "cortana": true,
    "microsoftConsumerExperience": true,
    "windowsTips": true,
    "commonProgramGroups": true,
    "partialStartMenu": true
  },
  "networkPerformance": {
    "dirCacheMax": 1,
    "dormantFileLimit": 1,
    "fileNotFoundCache": 1,
    "fileInfoCache": 1,
    "fileInfoCacheEnable": true,
    "directoryCacheEnable": true,
    "fileNotFoundCacheEnable": true,
    "dormantFileLimitEnable": true,
    "disableTCP": true,
    "disableIPv6CompEnable": true,
    "disableIPv6ToIPv4": true,
    "disableIsaTap": true
  },
  "customScript": {
    "arguments": "text",
    "command": "text",
    "initDir": "text",
    "user": "text"
  },
  "diskCleanup": {
    "cleanupWinSxSFolder": true,
    "cleanupSystemFiles": true,
    "cleanupTemporaryFileLogs": true,
    "removeOneDrive": true,
    "deleteUserProfiles": true
  },
  "visualEffects": {
    "visualEffectsTypes": [
      "0 = LetWindowsChooseWhatsBest",
      "1 = AdjustForBestAppearance",
      "2 = AdjustForBestPerformance",
      "3 = Custom"
    ],
    "animateControlSelectElements": true,
    "animateWindowsWhenMinimizingMaximizing": true,
    "animateTaskbar": true,
    "enablePeek": true,
    "fadeSlideMenus": true,
    "fadeSlideToolTips": true,
    "fadeOutMenuItems": true,
    "saveTaskbarThumbnail": true,
    "showShadowUnderMouse": true,
    "shadowUnderWindows": true,
    "thumbnailsInsteadOfIcons": true,
    "showTranslucentSelection": true,
    "showWindowsContentWhilstDragging": true,
    "slideOpenComboBoxes": true,
    "smoothEdgesScreenFonts": true,
    "smoothScrollListBoxes": true,
    "dropShadowsIcon": true
  },
  "windowsScheduledTasks": {
    "windowsScheduledTasksList": [
      {
        "task": "text",
        "location": "text",
        "type": [
          "0 = Folder",
          "1 = Task"
        ]
      }
    ]
  },
  "registry": {
    "registryList": [
      {
        "id": 1,
        "action": [
          "0 = Add",
          "1 = Modify",
          "2 = Delete"
        ],
        "registryName": "text",
        "dwordValue": 1,
        "displayName": "text",
        "hiveType": [
          "0 = HKEY_CURRENT_CONFIG",
          "1 = HKEY_USERS",
          "2 = HKEY_LOCAL_MACHINE",
          "3 = HKEY_CLASSES_ROOT"
        ],
        "path": "text",
        "regType": [
          "0 = REG_SZ",
          "1 = REG_DWORD",
          "2 = REG_QWORD",
          "3 = REG_MULTI_SZ",
          "4 = REG_EXPAND_SZ"
        ],
        "stringValue": "text"
      }
    ]
  },
  "uwpApps": {
    "allExcept": [
      "text"
    ],
    "followingPkgs": [
      "text"
    ],
    "removeType": [
      "0 = AllExcept",
      "1 = FollowingPkgs"
    ]
  }
}

List

get

Retrieve Default Windows Scheduled Task

Query parameters

siteIdinteger · int32Optional

The Site Id of the optimization setting to retrieve the windows scheduled task.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Accept: */*

[
  {
    "task": "text",
    "location": "text",
    "type": [
      "0 = Folder",
      "1 = Task"
    ]
  }
]

List

get

Retrieve Auto-upgrade Message(s).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages HTTP/1.1
Host: 
Accept: */*

[
  {
    "id": 1,
    "enabled": true,
    "messageTitle": "text",
    "message": "text",
    "sendMsgSecs": 1,
    "sendMsgWhen": [
      "0 = Before",
      "1 = After"
    ]
  }
]

Get

get

Retrieve an Auto-upgrade Message.

Path parameters

messageIdinteger · int32Required

The ID of the message to retrieve.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Delete

delete

Delete an Auto-upgrade Message by ID.

Path parameters

messageIdinteger · int32Required

The ID of the message to remove.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Accept: */*

No content

Get

get

Retrieves the FSLogix Office Container settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "advancedSettings": {
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useIncludeOfficeActivation": true,
    "includeOfficeActivation": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneDrive": true,
    "includeOneDrive": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNote": true,
    "includeOneNote": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOneNoteUWP": true,
    "includeOneNoteUWP": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlook": true,
    "includeOutlook": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeOutlookPersonalization": true,
    "includeOutlookPersonalization": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSharepoint": true,
    "includeSharepoint": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeSkype": true,
    "includeSkype": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useIncludeTeams": true,
    "includeTeams": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useMirrorLocalOSTToVHD": true,
    "mirrorLocalOSTToVHD": [
      "0 = DoNothing",
      "1 = Copy",
      "2 = Move"
    ],
    "useNumSessionVHDsToKeep": true,
    "numSessionVHDsToKeep": 1,
    "useOutlookFolderPath": true,
    "outlookFolderPath": "text",
    "useRefreshUserPolicy": true,
    "refreshUserPolicy": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDAccessMode": true,
    "vhdAccessMode": [
      "0 = NormalDirectAccess",
      "1 = DiffDiskNetwork",
      "2 = DiffDiskLocal",
      "3 = UniqueVHDPerSession"
    ]
  }
}

Get

get

Retrieves the FSLogix General Settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix General Settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/General HTTP/1.1
Host: 
Accept: */*

{
  "appServices": {
    "useCleanupInvalidSessions": true,
    "cleanupInvalidSessions": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamRecycleBin": true,
    "roamRecycleBin": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useVHDCompactDisk": true,
    "vhdCompactDisk": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "cloudCacheGeneral": {
    "useCacheDirectory": true,
    "cacheDirectory": "text",
    "useWriteCacheDirectory": true,
    "writeCacheDirectory": "text",
    "useProxyDirectory": true,
    "proxyDirectory": "text",
    "useSilenceACLWarning": true,
    "silenceACLWarning": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "logging": {
    "logEnabled": [
      "0 = Disable",
      "1 = Specific",
      "2 = All"
    ],
    "logLevel": [
      "0 = Debug",
      "1 = Information",
      "2 = Warning",
      "3 = Error"
    ],
    "logFileKeepingPeriod": 1,
    "logDirectory": "text",
    "robocopyLogPath": "text",
    "logSpecificComponents": [
      "1 = ProfileConfigTool",
      "2 = IEPlugin",
      "4 = RuleEditor",
      "8 = JavaRuleEditor",
      "16 = FSLogixAgentService",
      "32 = Profile",
      "64 = JavaLauncher",
      "128 = OfficeContainer",
      "256 = RuleCompilation",
      "512 = FontVisibility",
      "1024 = Network",
      "2048 = PrinterVisibility",
      "4096 = ADSComputerGroup",
      "8192 = DriverInterface",
      "16384 = WindowsSearchRoaming",
      "32768 = WindowsSearchPlugin",
      "65536 = ProcessStartMonitor"
    ]
  }
}

Get

get

Retrieves FSLogix Office Container User Exclusion List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/UserExclusion HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Get

get

Retrieve FSLogix Profile Container Folder Exclusion List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieves FSLogix Office Container User Inclusion List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Accept: */*

[
  {
    "account": "text",
    "type": [
      "1 = User",
      "2 = Group",
      "3 = ForeignSecurityPrincipal",
      "4 = Computer"
    ],
    "sid": "text"
  }
]

Get

get

Retrieve the FSLogix Profile Container settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer HTTP/1.1
Host: 
Accept: */*

{
  "enabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "userInclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "userExclusionList": [
    {
      "account": "text",
      "type": [
        "1 = User",
        "2 = Group",
        "3 = ForeignSecurityPrincipal",
        "4 = Computer"
      ],
      "sid": "text"
    }
  ],
  "cloudCache": {
    "useMaxCacheSizeInMBs": true,
    "maxCacheSizeInMBs": 1,
    "useClearCacheOnLogoff": true,
    "clearCacheOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useHealthyProvidersRequiredForRegister": true,
    "healthyProvidersRequiredForRegister": 1,
    "useHealthyProvidersRequiredForUnregister": true,
    "healthyProvidersRequiredForUnregister": 1,
    "useUnregisterTimeout": true,
    "unregisterTimeout": 1,
    "useClearCacheOnForcedUnregister": true,
    "clearCacheOnForcedUnregister": [
      "0 = Disable",
      "1 = Enable"
    ]
  },
  "customizeProfileFolders": true,
  "excludeCommonFolders": [
    "1 = Contacts",
    "2 = Desktop",
    "4 = Documents",
    "8 = Links",
    "16 = MusicPodcasts",
    "32 = PicturesVideos",
    "64 = FoldersLowIntegProcesses",
    "128 = Downloads"
  ],
  "folderInclusionList": [
    "text"
  ],
  "folderExclusionList": [
    {
      "folder": "text",
      "excludeFolderCopy": [
        "0 = None",
        "1 = CopyBase",
        "2 = CopyBack"
      ]
    }
  ],
  "advancedSettings": {
    "useLockedRetryCount": true,
    "lockedRetryCount": 1,
    "useLockedRetryInterval": true,
    "lockedRetryInterval": 1,
    "useAccessNetworkAsComputerObject": true,
    "accessNetworkAsComputerObject": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useAttachVHDSDDL": true,
    "attachVHDSDDL": "text",
    "useDiffDiskParentFolderPath": true,
    "diffDiskParentFolderPath": "text",
    "useFlipFlopProfileDirectoryName": true,
    "flipFlopProfileDirectoryName": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useNoProfileContainingFolder": true,
    "noProfileContainingFolder": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useOutlookCachedMode": true,
    "outlookCachedMode": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithFailure": true,
    "preventLoginWithFailure": [
      "0 = Disable",
      "1 = Enable"
    ],
    "usePreventLoginWithTempProfile": true,
    "preventLoginWithTempProfile": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useReAttachRetryCount": true,
    "reAttachRetryCount": 1,
    "useReAttachIntervalSeconds": true,
    "reAttachIntervalSeconds": 1,
    "useRemoveOrphanedOSTFilesOnLogoff": true,
    "removeOrphanedOSTFilesOnLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamSearch": true,
    "roamSearch": [
      "0 = Disable",
      "1 = SingleUser",
      "2 = MultiUser"
    ],
    "useSIDDirNameMatch": true,
    "sidDirNameMatch": "text",
    "useSIDDirNamePattern": true,
    "sidDirNamePattern": "text",
    "useSIDDirSDDL": true,
    "sidDirSDDL": "text",
    "useVHDNameMatch": true,
    "vhdNameMatch": "text",
    "useVHDNamePattern": true,
    "vhdNamePattern": "text",
    "useVHDXSectorSize": true,
    "vhdxSectorSize": [
      "0 = SystemDefault",
      "512 = Size_512",
      "4096 = Size_4096"
    ],
    "useVolumeWaitTimeMS": true,
    "volumeWaitTimeMS": 1,
    "useIgnoreNonAVD": true,
    "ignoreNonAVD": [
      "0 = AnySession",
      "1 = AVDSessions"
    ],
    "useRedirectType": true,
    "redirectType": [
      "1 = Legacy",
      "2 = Advanced"
    ],
    "useKeepLocalDir": true,
    "keepLocalDir": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useDeleteLocalProfileWhenVHDShouldApply": true,
    "deleteLocalProfileWhenVHDShouldApply": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useProfileDirSDDL": true,
    "profileDirSDDL": "text",
    "useProfileType": true,
    "profileType": [
      "0 = NormalProfile",
      "1 = OnlyRWProfile",
      "2 = OnlyROProfile",
      "3 = RWROProfile"
    ],
    "useSetTempToLocalPath": true,
    "setTempToLocalPath": [
      "0 = TakeNoAction",
      "1 = RedirectTempAndTmp",
      "2 = RedirectINetCache",
      "3 = RedirectTempTmpAndINetCache"
    ],
    "useCleanOutNotifications": true,
    "cleanOutNotifications": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useInstallAppxPackages": true,
    "installAppxPackages": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRebootOnUserLogoff": true,
    "rebootOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useRoamIdentity": true,
    "roamIdentity": [
      "0 = Disable",
      "1 = Enable"
    ],
    "useShutdownOnUserLogoff": true,
    "shutdownOnUserLogoff": [
      "0 = Disable",
      "1 = Enable"
    ]
  }
}

Get

get

Retrieve FSLogix Profile Container CCDLocation List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Profile Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/CCDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieves FSLogix Office Container CCDLocation List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/CCDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Get

get

Retrieves FSLogix Office Container VHDLocation List of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to retrieve the FSLogix Office Container settings (optional).

Responses

200

Success

application/json; api-version=1.0

Responsestring[]

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/VHDLocations HTTP/1.1
Host: 
Accept: */*

[
  "text"
]

Create Reboot

post

Creates a new Reboot Schedule.

Body

namestring | nullableRequired

Schedule name.

siteIdinteger · int32Optional

Site ID from which to retrieve the schedule.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

typeinteger · int32 | nullableOptional

Schedule type

startDateTimestring · date-timeOptional

Start time. Default: Now.

durationInSecsnumber · double | nullableOptional

Duration in seconds.

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

completeIninteger · int32 | nullableOptional

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypeinteger · int32 | nullableOptional

Whether to select the percentage or specific number of members to be started

percentageMembersinteger · int32 | nullableOptional

Percentage of members to be started

membersToStartinteger · int32 | nullableOptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableOptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableOptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableOptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableOptional

Enforce schedule for currently inactive host

onDisableboolean | nullableOptional

What action to take on Disable

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/Schedule/Reboot HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597

{
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "type": 1,
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "durationInSecs": 1,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "completeIn": 1,
  "poolMembersType": 1,
  "percentageMembers": 1,
  "membersToStart": 1,
  "powerOnAssignedPoolMembers": 1,
  "enableDrainMode": true,
  "forceServerRebootAfter": 1,
  "enforceScheduleInactiveHost": true,
  "onDisable": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "endDateTime": "2025-05-09T04:40:27.458Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Create

post

Create a Schedule Message.

Path parameters

idinteger · int32Required

The ID of the Schedule setting for which to create the message.

Body

enabledbooleanOptional

Whether to enable or disable the message.

messageTitlestring | nullableRequired

The title of the message.

messagestring | nullableRequired

A message that should be sent to users before the job starts.

sendMsgSecsinteger · int32Optional

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenstring · enumOptional

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

Possible values:

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/HostPool/Schedule/{id}/Messages HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

{
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

{
  "id": 1,
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

Update

put

Update a Schedule Message.

Path parameters

idinteger · int32Required

The ID of the Schedule setting for which to modify the message.

messageIdinteger · int32Required

The ID of the message to modify.

Body

enabledboolean | nullableOptional

Whether to enable or disable the message.

messageTitlestring | nullableOptional

The title of the message.

messagestring | nullableOptional

A message that should be sent to users before the job starts.

sendMsgSecsinteger · int32 | nullableOptional

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenstring · enumOptional

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/HostPool/Schedule/{id}/Messages/{messageId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

{
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

No content

Get

get

Get a list of the schedule setting's target ids.

Path parameters

Idinteger · int32Required

The ID of the Schedule setting for which to retrieve the target settings.

Body

objectOptional

Responses

200

Success

application/json; api-version=1.0

Responseinteger · int32[]

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

get

GET /api/AVD/HostPool/Schedule/{id}/Target HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2

{}

[
  1
]

Add

post

Add a Schedule target setting.

Path parameters

Idinteger · int32Required

The ID of the Schedule setting to modify.

Body

targetIDinteger · int32Required

The target RD Session Host server or server group Ids depending on the TargetType parameter.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/Schedule/{id}/Target HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 14

{
  "targetID": 1
}

No content

Delete

delete

Remove a Schedule target setting.

Path parameters

Idinteger · int32Required

The ID of the Schedule setting to modify.

Body

targetIDinteger · int32Required

The target RD Session Host server or server group Ids depending on the TargetType parameter.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/Schedule/{id}/Target HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 14

{
  "targetID": 1
}

No content

Create Startup

post

Creates a new Startup Schedule.

Body

namestring | nullableRequired

Schedule name.

siteIdinteger · int32Optional

Site ID from which to retrieve the schedule.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

typeinteger · int32 | nullableOptional

Schedule type

startDateTimestring · date-timeOptional

Start time. Default: Now.

durationInSecsnumber · double | nullableOptional

Duration in seconds.

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

completeIninteger · int32 | nullableOptional

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypeinteger · int32 | nullableOptional

Whether to select the percentage or specific number of members to be started

percentageMembersinteger · int32 | nullableOptional

Percentage of members to be started

membersToStartinteger · int32 | nullableOptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableOptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableOptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableOptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableOptional

Enforce schedule for currently inactive host

onDisableboolean | nullableOptional

What action to take on Disable

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/Schedule/Startup HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 597

{
  "name": "text",
  "siteId": 1,
  "enabled": true,
  "description": "text",
  "type": 1,
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "durationInSecs": 1,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "completeIn": 1,
  "poolMembersType": 1,
  "percentageMembers": 1,
  "membersToStart": 1,
  "powerOnAssignedPoolMembers": 1,
  "enableDrainMode": true,
  "forceServerRebootAfter": 1,
  "enforceScheduleInactiveHost": true,
  "onDisable": true
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "siteID": 1,
  "objType": [
    "44 = RDS",
    "92 = AVD",
    "100 = VDI"
  ],
  "action": [
    "0 = Disable",
    "1 = Reboot",
    "3 = Startup",
    "4 = Shutdown",
    "7 = Recreate"
  ],
  "targetType": [
    "0 = Host",
    "1 = HostPool"
  ],
  "enabled": true,
  "name": "text",
  "description": "text",
  "type": 1,
  "targetIDs": [
    1
  ],
  "targetNativeHosts": [
    {
      "poolId": 1,
      "guid": "text",
      "guestName": "text",
      "hostAzureID": "text"
    }
  ],
  "trigger": {
    "startDateTime": "2025-05-09T04:40:27.458Z",
    "endDateTime": "2025-05-09T04:40:27.458Z",
    "repeat": [
      "0 = Never",
      "1 = EveryDay",
      "2 = EveryWeek",
      "3 = Every2Weeks",
      "4 = EveryMonth",
      "5 = EveryYear",
      "6 = SpecificDays"
    ],
    "specificDays": [
      "0 = Never",
      "1 = Sunday",
      "2 = Monday",
      "4 = Tuesday",
      "8 = Wednesday",
      "16 = Thursday",
      "32 = Friday",
      "64 = Saturday"
    ],
    "durationInSecs": 1,
    "completeIn": 1
  },
  "options": {
    "poolMembersType": 1,
    "percentageMembers": 1,
    "membersToStart": 1,
    "powerOnAssignedPoolMembers": 1,
    "messages": [
      {
        "id": 1,
        "enabled": true,
        "messageTitle": "text",
        "message": "text",
        "sendMsgSecs": 1,
        "sendMsgWhen": [
          "0 = Before",
          "1 = After"
        ]
      }
    ],
    "enableDrainMode": true,
    "forceServerRebootAfter": 1,
    "enforceScheduleInactiveHost": true,
    "onDisable": true
  }
}

Update

put

Update the FSLogix General Settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix General Settings.

Body

useCleanupInvalidSessionsboolean | nullableOptional

Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.

cleanupInvalidSessionsstring · enumOptional

Enable State values.

Possible values:

useRoamRecycleBinboolean | nullableOptional

Specifies if the 'Roam recycle bin' option is enabled or disabled.

roamRecycleBinstring · enumOptional

Enable State values.

Possible values:

useVHDCompactDiskboolean | nullableOptional

Specifies if the 'VHD compact disk' option is enabled or disabled.

vhdCompactDiskstring · enumOptional

Enable State values.

Possible values:

useCacheDirectoryboolean | nullableOptional

Specifies if the 'Cache directory' option is enabled or disabled.

cacheDirectorystring | nullableOptional

Specifies the 'Cache directory'.

useWriteCacheDirectoryboolean | nullableOptional

Specifies if the 'Write cache directory' option is enabled or disabled.

writeCacheDirectorystring | nullableOptional

Specifies the 'Write cache directory'.

useProxyDirectoryboolean | nullableOptional

Specifies if the 'Proxy directory' option is enabled or disabled.

proxyDirectorystring | nullableOptional

Specifies the 'Proxy directory'.

useSilenceACLWarningboolean | nullableOptional

Specifies if the 'Silence ACL warning' option is enabled or disabled.

silenceACLWarningstring · enumOptional

Enable State values.

Possible values:

logEnabledstring · enumOptional

Log enabled values.

Possible values:

logLevelstring · enumOptional

FSLogix log level values.

Possible values:

logFileKeepingPeriodinteger · int32 | nullableOptional

Specifies the 'Log keeping period in days'. Default: '2'.

logDirectorystring | nullableOptional

Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.

robocopyLogPathstring | nullableOptional

Specifies the 'Robocopy log path'.

logSpecificComponentsstring[Flag] · enumOptional

Log specific components values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/HostPool/{id}/FSLogix/General HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1081

{
  "useCleanupInvalidSessions": true,
  "cleanupInvalidSessions": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamRecycleBin": true,
  "roamRecycleBin": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useVHDCompactDisk": true,
  "vhdCompactDisk": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useCacheDirectory": true,
  "cacheDirectory": "text",
  "useWriteCacheDirectory": true,
  "writeCacheDirectory": "text",
  "useProxyDirectory": true,
  "proxyDirectory": "text",
  "useSilenceACLWarning": true,
  "silenceACLWarning": [
    "0 = Disable",
    "1 = Enable"
  ],
  "logEnabled": [
    "0 = Disable",
    "1 = Specific",
    "2 = All"
  ],
  "logLevel": [
    "0 = Debug",
    "1 = Information",
    "2 = Warning",
    "3 = Error"
  ],
  "logFileKeepingPeriod": 1,
  "logDirectory": "text",
  "robocopyLogPath": "text",
  "logSpecificComponents": [
    "1 = ProfileConfigTool",
    "2 = IEPlugin",
    "4 = RuleEditor",
    "8 = JavaRuleEditor",
    "16 = FSLogixAgentService",
    "32 = Profile",
    "64 = JavaLauncher",
    "128 = OfficeContainer",
    "256 = RuleCompilation",
    "512 = FontVisibility",
    "1024 = Network",
    "2048 = PrinterVisibility",
    "4096 = ADSComputerGroup",
    "8192 = DriverInterface",
    "16384 = WindowsSearchRoaming",
    "32768 = WindowsSearchPlugin",
    "65536 = ProcessStartMonitor"
  ]
}

No content

Add

post

Adds a Windows Scheduled task to optimization.

Path parameters

idinteger · int32Required

The ID of the Optimization settings to retrieve the windows scheduled task.

Body

taskstring | nullableRequired

Scheduled Task Name

locationstring | nullableRequired

Scheduled Task Location

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33

{
  "task": "text",
  "location": "text"
}

No content

Delete

delete

Removes Windows Scheduled Task From Optimization.

Path parameters

idinteger · int32Required

The ID of the optimization setting to remove the windows scheduled task.

Body

taskstring | nullableRequired

Scheduled Task

locationstring | nullableRequired

Scheduled Task Location

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33

{
  "task": "text",
  "location": "text"
}

No content

Add

post

Adds a Windows Service Custom to optimization.

Path parameters

idinteger · int32Required

The ID of the Optimization settings to add the windows services custom.

Body

aliasesstring | nullableOptional

Windows Services Alias

displayNamestring | nullableOptional

Windows Services Diplay Name

serviceNamestring | nullableOptional

Windows Service Name

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/Optimization/WindowsService HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 60

{
  "aliases": "text",
  "displayName": "text",
  "serviceName": "text"
}

No content

Delete

delete

Removes Windows Service Custom From Optimization.

Path parameters

idinteger · int32Required

The ID of the optimization setting to remove the windows Service custom.

Body

serviceNamestring | nullableOptional

Windows Service Name

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/Optimization/WindowsService HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "serviceName": "text"
}

No content

Add

post

Add a user to the User Exclusion List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user from the User Exclusion List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/UserExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Update

put

Update the FSLogix Profile Container settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Update FSLogix profile configuration of a Sessions Host

profileContainerEnabledboolean | nullableOptional

Specifies if the Profile Container is enabled or disabled..

locationTypestring · enumOptional

Location Type values.

Possible values:

vhdLocationsstring[] | nullableOptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] | nullableOptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumOptional

Profile Disk Format values.

Possible values:

allocationTypestring · enumOptional

Allocation Type values.

Possible values:

defaultSizeinteger · int32 | nullableOptional

Specifies the 'Default size'.

customizeProfileFoldersboolean | nullableOptional

Enable or disable the 'Customize Profile Folders' option.

excludeCommonFoldersstring[Flag] · enumOptional

Exclude Common Folders.

Possible values:

useLockedRetryCountboolean | nullableOptional

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger · int32 | nullableOptional

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean | nullableOptional

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger · int32 | nullableOptional

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean | nullableOptional

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectstring · enumOptional

Enable State values.

Possible values:

useAttachVHDSDDLboolean | nullableOptional

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLstring | nullableOptional

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean | nullableOptional

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathstring | nullableOptional

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean | nullableOptional

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNamestring · enumOptional

Enable State values.

Possible values:

useNoProfileContainingFolderboolean | nullableOptional

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderstring · enumOptional

Enable State values.

Possible values:

useOutlookCachedModeboolean | nullableOptional

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithFailureboolean | nullableOptional

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailurestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithTempProfileboolean | nullableOptional

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfilestring · enumOptional

Enable State values.

Possible values:

useReAttachRetryCountboolean | nullableOptional

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger · int32 | nullableOptional

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean | nullableOptional

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger · int32 | nullableOptional

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean | nullableOptional

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamSearchboolean | nullableOptional

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchstring · enumOptional

Roam search values.

Possible values:

useSIDDirNameMatchboolean | nullableOptional

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchstring | nullableOptional

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean | nullableOptional

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternstring | nullableOptional

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean | nullableOptional

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLstring | nullableOptional

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean | nullableOptional

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchstring | nullableOptional

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean | nullableOptional

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternstring | nullableOptional

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean | nullableOptional

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizestring · enumOptional

Enable State values.

Possible values:

useVolumeWaitTimeMSboolean | nullableOptional

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger · int32 | nullableOptional

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean | nullableOptional

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDstring · enumOptional

Ignore non-AVD values.

Possible values:

useRedirectTypeboolean | nullableOptional

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypestring · enumOptional

Redirect type values.

Possible values:

useKeepLocalDirboolean | nullableOptional

Specifies if the 'Keep local profiles' option is enabled or disabled.

keepLocalDirstring · enumOptional

Enable State values.

Possible values:

useDeleteLocalProfileWhenVHDShouldApplyboolean | nullableOptional

Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.

deleteLocalProfileWhenVHDShouldApplystring · enumOptional

Enable State values.

Possible values:

useProfileDirSDDLboolean | nullableOptional

Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.

profileDirSDDLstring | nullableOptional

Specifies the 'Custom SDDL for profile directory'.

useProfileTypeboolean | nullableOptional

Specifies if the 'Profile type' option is enabled or disabled.

profileTypestring · enumOptional

Profile Type values.

Possible values:

useSetTempToLocalPathboolean | nullableOptional

Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.

setTempToLocalPathstring · enumOptional

Temporary Folder Redirection Mode values.

Possible values:

useCleanOutNotificationsboolean | nullableOptional

Specifies if the 'Clean out notifications' option is enabled or disabled.

cleanOutNotificationsstring · enumOptional

Enable State values.

Possible values:

useInstallAppxPackagesboolean | nullableOptional

Specifies if the Install Appx packages' option is enabled or disabled.

installAppxPackagesstring · enumOptional

Enable State values.

Possible values:

useRebootOnUserLogoffboolean | nullableOptional

Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.

rebootOnUserLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamIdentityboolean | nullableOptional

Specifies if the 'Roam identity' option is enabled or disabled.

roamIdentitystring · enumOptional

Enable State values.

Possible values:

useShutdownOnUserLogoffboolean | nullableOptional

Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.

shutdownOnUserLogoffstring · enumOptional

Enable State values.

Possible values:

useMaxCacheSizeInMBsboolean | nullableOptional

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger · int32 | nullableOptional

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean | nullableOptional

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffstring · enumOptional

Enable State values.

Possible values:

useHealthyProvidersRequiredForRegisterboolean | nullableOptional

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean | nullableOptional

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean | nullableOptional

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger · int32 | nullableOptional

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean | nullableOptional

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterstring · enumOptional

Enable State values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/HostPool/{id}/FSLogix/ProfileContainer HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3397

{
  "profileContainerEnabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "customizeProfileFolders": true,
  "excludeCommonFolders": [
    "1 = Contacts",
    "2 = Desktop",
    "4 = Documents",
    "8 = Links",
    "16 = MusicPodcasts",
    "32 = PicturesVideos",
    "64 = FoldersLowIntegProcesses",
    "128 = Downloads"
  ],
  "useLockedRetryCount": true,
  "lockedRetryCount": 1,
  "useLockedRetryInterval": true,
  "lockedRetryInterval": 1,
  "useAccessNetworkAsComputerObject": true,
  "accessNetworkAsComputerObject": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useAttachVHDSDDL": true,
  "attachVHDSDDL": "text",
  "useDiffDiskParentFolderPath": true,
  "diffDiskParentFolderPath": "text",
  "useFlipFlopProfileDirectoryName": true,
  "flipFlopProfileDirectoryName": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useNoProfileContainingFolder": true,
  "noProfileContainingFolder": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useOutlookCachedMode": true,
  "outlookCachedMode": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithFailure": true,
  "preventLoginWithFailure": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithTempProfile": true,
  "preventLoginWithTempProfile": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useReAttachRetryCount": true,
  "reAttachRetryCount": 1,
  "useReAttachIntervalSeconds": true,
  "reAttachIntervalSeconds": 1,
  "useRemoveOrphanedOSTFilesOnLogoff": true,
  "removeOrphanedOSTFilesOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamSearch": true,
  "roamSearch": [
    "0 = Disable",
    "1 = SingleUser",
    "2 = MultiUser"
  ],
  "useSIDDirNameMatch": true,
  "sidDirNameMatch": "text",
  "useSIDDirNamePattern": true,
  "sidDirNamePattern": "text",
  "useSIDDirSDDL": true,
  "sidDirSDDL": "text",
  "useVHDNameMatch": true,
  "vhdNameMatch": "text",
  "useVHDNamePattern": true,
  "vhdNamePattern": "text",
  "useVHDXSectorSize": true,
  "vhdxSectorSize": [
    "0 = SystemDefault",
    "512 = Size_512",
    "4096 = Size_4096"
  ],
  "useVolumeWaitTimeMS": true,
  "volumeWaitTimeMS": 1,
  "useIgnoreNonAVD": true,
  "ignoreNonAVD": [
    "0 = AnySession",
    "1 = AVDSessions"
  ],
  "useRedirectType": true,
  "redirectType": [
    "1 = Legacy",
    "2 = Advanced"
  ],
  "useKeepLocalDir": true,
  "keepLocalDir": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useDeleteLocalProfileWhenVHDShouldApply": true,
  "deleteLocalProfileWhenVHDShouldApply": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useProfileDirSDDL": true,
  "profileDirSDDL": "text",
  "useProfileType": true,
  "profileType": [
    "0 = NormalProfile",
    "1 = OnlyRWProfile",
    "2 = OnlyROProfile",
    "3 = RWROProfile"
  ],
  "useSetTempToLocalPath": true,
  "setTempToLocalPath": [
    "0 = TakeNoAction",
    "1 = RedirectTempAndTmp",
    "2 = RedirectINetCache",
    "3 = RedirectTempTmpAndINetCache"
  ],
  "useCleanOutNotifications": true,
  "cleanOutNotifications": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useInstallAppxPackages": true,
  "installAppxPackages": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRebootOnUserLogoff": true,
  "rebootOnUserLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamIdentity": true,
  "roamIdentity": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useShutdownOnUserLogoff": true,
  "shutdownOnUserLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useMaxCacheSizeInMBs": true,
  "maxCacheSizeInMBs": 1,
  "useClearCacheOnLogoff": true,
  "clearCacheOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useHealthyProvidersRequiredForRegister": true,
  "healthyProvidersRequiredForRegister": 1,
  "useHealthyProvidersRequiredForUnregister": true,
  "healthyProvidersRequiredForUnregister": 1,
  "useUnregisterTimeout": true,
  "unregisterTimeout": 1,
  "useClearCacheOnForcedUnregister": true,
  "clearCacheOnForcedUnregister": [
    "0 = Disable",
    "1 = Enable"
  ]
}

No content

Add

post

Add a user to the User Inclusion List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user from the User Inclusion List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Update

put

Update the FSLogix Office Container settings of a session server with the specified ID.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

officeContainerEnabledboolean | nullableOptional

Specifies if the Office Container is enabled or disabled.

locationTypestring · enumOptional

Location Type values.

Possible values:

vhdLocationsstring[] | nullableOptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] | nullableOptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumOptional

Profile Disk Format values.

Possible values:

allocationTypestring · enumOptional

Allocation Type values.

Possible values:

defaultSizeinteger · int32 | nullableOptional

Specifies the 'Default size'.

useLockedRetryCountboolean | nullableOptional

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger · int32 | nullableOptional

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean | nullableOptional

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger · int32 | nullableOptional

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean | nullableOptional

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectstring · enumOptional

Enable State values.

Possible values:

useAttachVHDSDDLboolean | nullableOptional

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLstring | nullableOptional

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean | nullableOptional

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathstring | nullableOptional

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean | nullableOptional

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNamestring · enumOptional

Enable State values.

Possible values:

useNoProfileContainingFolderboolean | nullableOptional

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderstring · enumOptional

Enable State values.

Possible values:

useOutlookCachedModeboolean | nullableOptional

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithFailureboolean | nullableOptional

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailurestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithTempProfileboolean | nullableOptional

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfilestring · enumOptional

Enable State values.

Possible values:

useReAttachRetryCountboolean | nullableOptional

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger · int32 | nullableOptional

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean | nullableOptional

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger · int32 | nullableOptional

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean | nullableOptional

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamSearchboolean | nullableOptional

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchstring · enumOptional

Roam search values.

Possible values:

useSIDDirNameMatchboolean | nullableOptional

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchstring | nullableOptional

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean | nullableOptional

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternstring | nullableOptional

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean | nullableOptional

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLstring | nullableOptional

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean | nullableOptional

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchstring | nullableOptional

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean | nullableOptional

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternstring | nullableOptional

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean | nullableOptional

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizestring · enumOptional

Enable State values.

Possible values:

useVolumeWaitTimeMSboolean | nullableOptional

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger · int32 | nullableOptional

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean | nullableOptional

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDstring · enumOptional

Ignore non-AVD values.

Possible values:

useRedirectTypeboolean | nullableOptional

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypestring · enumOptional

Redirect type values.

Possible values:

useIncludeOfficeActivationboolean | nullableOptional

Specifies if the 'Include Office Activation' option is enabled or disabled.

includeOfficeActivationstring · enumOptional

Enable State values.

Possible values:

useIncludeOneDriveboolean | nullableOptional

Specifies if the 'Include OneDrive' option is enabled or disabled.

includeOneDrivestring · enumOptional

Enable State values.

Possible values:

useIncludeOneNoteboolean | nullableOptional

Specifies if the 'Include OneNote' option is enabled or disabled.

includeOneNotestring · enumOptional

Enable State values.

Possible values:

useIncludeOneNoteUWPboolean | nullableOptional

Specifies if the 'Include OneNote UWP' option is enabled or disabled.

includeOneNoteUWPstring · enumOptional

Enable State values.

Possible values:

useIncludeOutlookboolean | nullableOptional

Specifies if the 'Include Outlook' option is enabled or disabled.

includeOutlookstring · enumOptional

Enable State values.

Possible values:

useIncludeOutlookPersonalizationboolean | nullableOptional

Specifies if the 'Include Outlook Personalization' option is enabled or disabled.

includeOutlookPersonalizationstring · enumOptional

Enable State values.

Possible values:

useIncludeSharepointboolean | nullableOptional

Specifies if the 'Include Sharepoint' option is enabled or disabled.

includeSharepointstring · enumOptional

Enable State values.

Possible values:

useIncludeSkypeboolean | nullableOptional

Specifies if the 'Include Skype' option is enabled or disabled.

includeSkypestring · enumOptional

Enable State values.

Possible values:

useIncludeTeamsboolean | nullableOptional

Specifies if the 'Include Teams' option is enabled or disabled.

includeTeamsstring · enumOptional

Enable State values.

Possible values:

useMirrorLocalOSTToVHDboolean | nullableOptional

Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.

mirrorLocalOSTToVHDstring · enumOptional

Mirror Local OST-VHD values.

Possible values:

useNumSessionVHDsToKeepboolean | nullableOptional

Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.

numSessionVHDsToKeepinteger · int32 | nullableOptional

Specifies the 'Number of Session VHDs to Keep'.

useOutlookFolderPathboolean | nullableOptional

Specifies if the 'Outlook Folder Path' option is enabled or disabled.

outlookFolderPathstring | nullableOptional

Specifies the 'Outlook Folder Path'.

useRefreshUserPolicyboolean | nullableOptional

Specifies if the 'Refresh User Policy' option is enabled or disabled.

refreshUserPolicystring · enumOptional

Enable State values.

Possible values:

useVHDAccessModeboolean | nullableOptional

Specifies if the 'VHD Access Mode' option is enabled or disabled.

vhdAccessModestring · enumOptional

VHD Access Mode values.

Possible values:

useMaxCacheSizeInMBsboolean | nullableOptional

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger · int32 | nullableOptional

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean | nullableOptional

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffstring · enumOptional

Enable State values.

Possible values:

useHealthyProvidersRequiredForRegisterboolean | nullableOptional

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean | nullableOptional

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean | nullableOptional

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger · int32 | nullableOptional

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean | nullableOptional

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterstring · enumOptional

Enable State values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/HostPool/{id}/FSLogix/OfficeContainer HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3402

{
  "officeContainerEnabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "useLockedRetryCount": true,
  "lockedRetryCount": 1,
  "useLockedRetryInterval": true,
  "lockedRetryInterval": 1,
  "useAccessNetworkAsComputerObject": true,
  "accessNetworkAsComputerObject": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useAttachVHDSDDL": true,
  "attachVHDSDDL": "text",
  "useDiffDiskParentFolderPath": true,
  "diffDiskParentFolderPath": "text",
  "useFlipFlopProfileDirectoryName": true,
  "flipFlopProfileDirectoryName": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useNoProfileContainingFolder": true,
  "noProfileContainingFolder": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useOutlookCachedMode": true,
  "outlookCachedMode": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithFailure": true,
  "preventLoginWithFailure": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithTempProfile": true,
  "preventLoginWithTempProfile": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useReAttachRetryCount": true,
  "reAttachRetryCount": 1,
  "useReAttachIntervalSeconds": true,
  "reAttachIntervalSeconds": 1,
  "useRemoveOrphanedOSTFilesOnLogoff": true,
  "removeOrphanedOSTFilesOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamSearch": true,
  "roamSearch": [
    "0 = Disable",
    "1 = SingleUser",
    "2 = MultiUser"
  ],
  "useSIDDirNameMatch": true,
  "sidDirNameMatch": "text",
  "useSIDDirNamePattern": true,
  "sidDirNamePattern": "text",
  "useSIDDirSDDL": true,
  "sidDirSDDL": "text",
  "useVHDNameMatch": true,
  "vhdNameMatch": "text",
  "useVHDNamePattern": true,
  "vhdNamePattern": "text",
  "useVHDXSectorSize": true,
  "vhdxSectorSize": [
    "0 = SystemDefault",
    "512 = Size_512",
    "4096 = Size_4096"
  ],
  "useVolumeWaitTimeMS": true,
  "volumeWaitTimeMS": 1,
  "useIgnoreNonAVD": true,
  "ignoreNonAVD": [
    "0 = AnySession",
    "1 = AVDSessions"
  ],
  "useRedirectType": true,
  "redirectType": [
    "1 = Legacy",
    "2 = Advanced"
  ],
  "useIncludeOfficeActivation": true,
  "includeOfficeActivation": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOneDrive": true,
  "includeOneDrive": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOneNote": true,
  "includeOneNote": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOneNoteUWP": true,
  "includeOneNoteUWP": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOutlook": true,
  "includeOutlook": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOutlookPersonalization": true,
  "includeOutlookPersonalization": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeSharepoint": true,
  "includeSharepoint": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeSkype": true,
  "includeSkype": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeTeams": true,
  "includeTeams": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useMirrorLocalOSTToVHD": true,
  "mirrorLocalOSTToVHD": [
    "0 = DoNothing",
    "1 = Copy",
    "2 = Move"
  ],
  "useNumSessionVHDsToKeep": true,
  "numSessionVHDsToKeep": 1,
  "useOutlookFolderPath": true,
  "outlookFolderPath": "text",
  "useRefreshUserPolicy": true,
  "refreshUserPolicy": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useVHDAccessMode": true,
  "vhdAccessMode": [
    "0 = NormalDirectAccess",
    "1 = DiffDiskNetwork",
    "2 = DiffDiskLocal",
    "3 = UniqueVHDPerSession"
  ],
  "useMaxCacheSizeInMBs": true,
  "maxCacheSizeInMBs": 1,
  "useClearCacheOnLogoff": true,
  "clearCacheOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useHealthyProvidersRequiredForRegister": true,
  "healthyProvidersRequiredForRegister": 1,
  "useHealthyProvidersRequiredForUnregister": true,
  "healthyProvidersRequiredForUnregister": 1,
  "useUnregisterTimeout": true,
  "unregisterTimeout": 1,
  "useClearCacheOnForcedUnregister": true,
  "clearCacheOnForcedUnregister": [
    "0 = Disable",
    "1 = Enable"
  ]
}

No content

Add

post

Add a folder to the CCDLocation List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Add a new CCDLocation to the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to add to the CCDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Remove

delete

Remove a folder from the CCDLocation List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Remove a CCDLocation from the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to remove from the CCDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Update

put

Modify properties of a Schedule setting.

Path parameters

idinteger · int32Required

The ID of the Schedule setting to modify.

Body

newNamestring | nullableOptional

A new name for the scheduler job.

enabledboolean | nullableOptional

Whether to enable or disable the schedule.

descriptionstring | nullableOptional

Schedule description.

startDateTimestring · date-time | nullableOptional

Start time. Default: Now.

durationInSecsnumber · double | nullableOptional

Duration in seconds.

repeatstring · enumOptional

Repeat Type

Possible values:

specificDaysstring[Flag] · enumOptional

Repeat Specific Days

Possible values:

completeIninteger · int32 | nullableOptional

The duration of the scheduler task in minutes. Default: 15 minutes for disable task, 10 minutes for reboot task.

poolMembersTypeinteger · int32 | nullableOptional

Whether to select the percentage or specific number of members to be started

percentageMembersinteger · int32 | nullableOptional

Percentage of members to be started

membersToStartinteger · int32 | nullableOptional

Specific number of members to be started

powerOnAssignedPoolMembersinteger · int32 | nullableOptional

Power On Assigned Pool Members

enableDrainModeboolean | nullableOptional

Whether to enable Drain Mode

forceServerRebootAfterinteger · int32 | nullableOptional

Force server reboot after the specified time in seconds

enforceScheduleInactiveHostboolean | nullableOptional

Enforce schedule for currently inactive host

onDisableboolean | nullableOptional

What action to take on Disable

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "newName": "text",
  "enabled": true,
  "description": "text",
  "startDateTime": "2025-05-09T04:40:27.458Z",
  "durationInSecs": 1,
  "repeat": [
    "0 = Never",
    "1 = EveryDay",
    "2 = EveryWeek",
    "3 = Every2Weeks",
    "4 = EveryMonth",
    "5 = EveryYear",
    "6 = SpecificDays"
  ],
  "specificDays": [
    "0 = Never",
    "1 = Sunday",
    "2 = Monday",
    "4 = Tuesday",
    "8 = Wednesday",
    "16 = Thursday",
    "32 = Friday",
    "64 = Saturday"
  ],
  "completeIn": 1,
  "poolMembersType": 1,
  "percentageMembers": 1,
  "membersToStart": 1,
  "powerOnAssignedPoolMembers": 1,
  "enableDrainMode": true,
  "forceServerRebootAfter": 1,
  "enforceScheduleInactiveHost": true,
  "onDisable": true
}

No content

Add

post

Add a folder to the VHDLocation List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Add a new VHDLocation to the FSLogix VHDLocation list

vhdLocationstring | nullableRequired

Specifies the 'VHDLocation' path to add to the VHDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "vhdLocation": "text"
}

No content

Delete

delete

Remove a folder from the VHDLocation List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Remove a VHDLocation from the FSLogix VHDLocation list

vhdLocationstring | nullableRequired

Specifies the 'VHDLocation' path to remove from the VHDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/VHDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "vhdLocation": "text"
}

No content

Add

post

Add a folder to the CCDLocation List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Add a new CCDLocation to the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to add to the CCDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Delete

delete

Remove a folder from the CCDLocation List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Remove a CCDLocation from the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to remove from the CCDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Add

post

Add a folder to the Folder Exclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Add FSLogix Folder Exclusion

folderstring | nullableRequired

Specifies the 'Folder' path to add to the Include/Exclude Folder List.

excludeFolderCopystring[Flag] · enumOptional

Exclude Folder Copy values.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 80

{
  "folder": "text",
  "excludeFolderCopy": [
    "0 = None",
    "1 = CopyBase",
    "2 = CopyBack"
  ]
}

No content

Update

put

Modify an item in the folder exclusion list of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Change folder configuration in the FSLogix folder exclusion list

folderstring | nullableRequired

Specifies the 'Folder' path to modify within Exclude Folder List.

excludeFolderCopystring[Flag] · enumRequired

Exclude Folder Copy values.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

put

PUT /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 80

{
  "folder": "text",
  "excludeFolderCopy": [
    "0 = None",
    "1 = CopyBase",
    "2 = CopyBack"
  ]
}

No content

Delete

delete

Remove a folder from the Folder Exclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Remove a folder from the FSLogix folder inclusion list

folderstring | nullableRequired

Specifies the 'Folder' path to remove to the Include/Exclude Folder List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 17

{
  "folder": "text"
}

No content

Add

post

Add a folder to the Folder Inclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Add a new folder to the FSLogix folder inclusion list

folderstring | nullableRequired

Specifies the 'Folder' path to add to the Include/Exclude Folder List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 17

{
  "folder": "text"
}

No content

Delete

delete

Remove a folder from the Folder Inclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Remove a folder from the FSLogix folder inclusion list

folderstring | nullableRequired

Specifies the 'Folder' path to remove to the Include/Exclude Folder List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/FolderInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 17

{
  "folder": "text"
}

No content

Add

post

Add a folder to the VHDLocation List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Add a new VHDLocation to the FSLogix VHDLocation list

vhdLocationstring | nullableRequired

Specifies the 'VHDLocation' path to add to the VHDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "vhdLocation": "text"
}

No content

Remove

delete

Remove a folder from the VHDLocation List of the FSLogix Office Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Office Container settings.

Body

Remove a VHDLocation from the FSLogix VHDLocation list

vhdLocationstring | nullableRequired

Specifies the 'VHDLocation' path to remove from the VHDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/OfficeContainer/VHDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "vhdLocation": "text"
}

No content

Add

post

Add a user to the User Exclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Delete

delete

Remove a user from the User Exclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Add

post

Add a user to the User Inclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Delete

delete

Remove a user from the User Inclusion List of the FSLogix Profile Container settings.

Path parameters

idinteger · int32Required

The ID of a session server for which to modify the FSLogix Profile Container settings.

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/HostPool/{id}/FSLogix/ProfileContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Update

put

Update the Azure Virtual Desktop Feature Site Settings.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to modify the Azure Virtual Desktop Feature settings.

Body

Update AVD feature settings in the RAS Site

enabledboolean | nullableOptional

Enable or disable the Azure Virtual Desktop management.

clientFeatureSetstring · enumOptional

Client feature set Type values.

Possible values:

replicateboolean | nullableOptional

Enable or disable replication of settings to other sites.

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/Settings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 111

{
  "enabled": true,
  "clientFeatureSet": [
    "0 = Standard",
    "1 = Advanced",
    "2 = AdvancedWithFallback"
  ],
  "replicate": true
}

No content

Create

post

Creates a new RAS Template.

Body

providerIdinteger · int32Required

The ID of a Provider on which the source desktop VM resides.

vmIdstring | nullableRequired

The ID of the source VM.

namestring | nullableOptional

RAS Template Name.

siteIdinteger · int32Optional

The site ID in which to create the RAS Template info. If the parameter is omitted, the site ID of the Licensing Server will be used.

descriptionstring | nullableOptional

RAS Template Description.

templateTypestring · enumOptional

Host Session Type

Possible values:

cloneMethodstring · enumOptional

Clone Method

Possible values:

folderNamestring | nullableOptional

Folder name where desktop VMs will be created.

folderIdstring | nullableOptional

The ID of a folder where desktop VMs will be created.

subFolderNamestring | nullableOptional

Subfolder name where desktop VMs will be created.

nativePoolIdstring | nullableOptional

The ID of the native pool where desktop VMs will be created.

nativePoolNamestring | nullableOptional

The name of the native pool where desktop VMs will be created.

hwgpubooleanOptional

Enable hardware acceleration graphics licensing support.

physicalHostIdstring | nullableOptional

The ID of a physical host where desktop VMs will be created.

physicalHostNamestring | nullableOptional

The name of a physical host where desktop VMs will be created.

useSeperateNetworkInterfacebooleanOptional

Use a separate network interface for LAN access.

addressstring | nullableOptional

The address of the network interface.

subnetMaskstring | nullableOptional

The subnet mask of the network interface.

instanceTypestring | nullableOptional

Instance type.

deviceNamestring | nullableOptional

Device name.

volumeTypestring · enumOptional

Volume type

Possible values:

sizeinteger · int32Optional

Size (GiB).

maximumIOPSinteger · int64 | nullableOptional

Maximum IOPS.

throughputinteger · int64 | nullableOptional

Throughput (MB/s).

resourceGroupstring | nullableOptional

Resource group.

vmSizestring | nullableOptional

VM size.

osDiskTypestring · enumOptional

Volume type

Possible values:

virtualNetworkIDstring | nullableOptional

Virtual network ID.

virtualNetworkNamestring | nullableOptional

Virtual network name.

subnetIDstring | nullableOptional

Subnet ID.

subnetNamestring | nullableOptional

Subnet name.

imagePrepToolstring · enumOptional

Image preparation tool

Possible values:

computerNamestring | nullableOptional

The FQDN or IP address of the target VM.

ownerNamestring | nullableOptional

A desktop VM owner name (assigned to a VM by RASprep or Sysprep).

organizationstring | nullableOptional

Organization name (assigned to a VM by RASprep or Sysprep).

domainstring | nullableRequired

Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).

domainPasswordstring | nullableRequired

The password of the domain administrator specified in the Administrator parameter.

administratorstring | nullableRequired

The administrator of the domain specified in the JoinDomain parameter.

adminPasswordstring | nullableRequired

The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).

domainOrgUnitstring | nullableOptional

Domain Organization unit

Responses

201

Created

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/Template HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 993

{
  "providerId": 1,
  "vmId": "text",
  "name": "text",
  "siteId": 1,
  "description": "text",
  "templateType": [
    "0 = SingleSession",
    "1 = MultiSession"
  ],
  "cloneMethod": [
    "0 = FullClone",
    "1 = LinkedClone"
  ],
  "folderName": "text",
  "folderId": "text",
  "subFolderName": "text",
  "nativePoolId": "text",
  "nativePoolName": "text",
  "hwgpu": true,
  "physicalHostId": "text",
  "physicalHostName": "text",
  "useSeperateNetworkInterface": true,
  "address": "text",
  "subnetMask": "text",
  "instanceType": "text",
  "deviceName": "text",
  "volumeType": [
    "0 = gp2",
    "1 = gp3",
    "2 = io1",
    "3 = io2",
    "4 = standard"
  ],
  "size": 1,
  "maximumIOPS": 1,
  "throughput": 1,
  "resourceGroup": "text",
  "vmSize": "text",
  "osDiskType": [
    "1 = StandardHDD",
    "2 = StandardSSD",
    "4 = PremiumSSD"
  ],
  "virtualNetworkID": "text",
  "virtualNetworkName": "text",
  "subnetID": "text",
  "subnetName": "text",
  "imagePrepTool": [
    "0 = SysPrep",
    "1 = RASPrep"
  ],
  "computerName": "text",
  "ownerName": "text",
  "organization": "text",
  "domain": "text",
  "domainPassword": "text",
  "administrator": "text",
  "adminPassword": "text",
  "domainOrgUnit": "text"
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "objType": [
    "89 = AVDTemplate",
    "101 = RDSTemplate",
    "102 = VDITemplate"
  ],
  "name": "text",
  "siteId": 1,
  "description": "text",
  "providerId": 1,
  "templateType": [
    "0 = SingleSession",
    "1 = MultiSession"
  ],
  "vmId": "text",
  "cloneMethod": [
    "0 = FullClone",
    "1 = LinkedClone"
  ],
  "advanced": {
    "folder": {
      "folderName": "text",
      "folderId": "text",
      "subFolderName": "text"
    },
    "nativePool": {
      "nativePoolId": "text",
      "nativePoolName": "text",
      "hwgpu": true
    },
    "physicalHost": {
      "physicalHostId": "text",
      "physicalHostName": "text"
    },
    "multipleNIC": {
      "useSeperateNetworkInterface": true,
      "address": "text",
      "subnetMask": "text"
    },
    "aws": {
      "instanceType": "text",
      "storageDevices": [
        {
          "deviceName": "text",
          "volumeType": [
            "0 = gp2",
            "1 = gp3",
            "2 = io1",
            "3 = io2",
            "4 = standard"
          ],
          "size": 1,
          "maximumIOPS": 1,
          "throughput": 1
        }
      ]
    },
    "azure": {
      "resourceGroup": "text",
      "location": "text",
      "vmSize": "text",
      "osDiskType": [
        "1 = StandardHDD",
        "2 = StandardSSD",
        "4 = PremiumSSD"
      ],
      "virtualNetworkID": "text",
      "virtualNetworkName": "text",
      "subnet": {
        "subnetID": "text",
        "subnetName": "text"
      }
    }
  },
  "preparation": {
    "imagePrepTool": [
      "0 = SysPrep",
      "1 = RASPrep"
    ],
    "computerName": "text",
    "ownerName": "text",
    "organization": "text",
    "administrator": "text",
    "domain": "text",
    "domainOrgUnit": "text"
  },
  "inheritDefaultOptimizationSettings": true,
  "optimization": {
    "enableOptimization": true,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": true,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": true,
    "windowsComponentsEnabled": true,
    "windowsServicesEnabled": true,
    "windowsScheduledTasksEnabled": true,
    "windowsAdvancedOptionsEnabled": true,
    "networkPerformanceEnabled": true,
    "registryEnabled": true,
    "visualEffectsEnabled": true,
    "diskCleanupEnabled": true,
    "customScriptEnabled": true,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": true,
      "teleCollection": true,
      "systemRestore": true,
      "additionalErrorReport": true,
      "tiles": true,
      "cortana": true,
      "microsoftConsumerExperience": true,
      "windowsTips": true,
      "commonProgramGroups": true,
      "partialStartMenu": true
    },
    "networkPerformance": {
      "dirCacheMax": 1,
      "dormantFileLimit": 1,
      "fileNotFoundCache": 1,
      "fileInfoCache": 1,
      "fileInfoCacheEnable": true,
      "directoryCacheEnable": true,
      "fileNotFoundCacheEnable": true,
      "dormantFileLimitEnable": true,
      "disableTCP": true,
      "disableIPv6CompEnable": true,
      "disableIPv6ToIPv4": true,
      "disableIsaTap": true
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": true,
      "cleanupSystemFiles": true,
      "cleanupTemporaryFileLogs": true,
      "removeOneDrive": true,
      "deleteUserProfiles": true
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": true,
      "animateWindowsWhenMinimizingMaximizing": true,
      "animateTaskbar": true,
      "enablePeek": true,
      "fadeSlideMenus": true,
      "fadeSlideToolTips": true,
      "fadeOutMenuItems": true,
      "saveTaskbarThumbnail": true,
      "showShadowUnderMouse": true,
      "shadowUnderWindows": true,
      "thumbnailsInsteadOfIcons": true,
      "showTranslucentSelection": true,
      "showWindowsContentWhilstDragging": true,
      "slideOpenComboBoxes": true,
      "smoothEdgesScreenFonts": true,
      "smoothScrollListBoxes": true,
      "dropShadowsIcon": true
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 1,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 1,
          "displayName": "text",
          "hiveType": [
            "0 = HKEY_CURRENT_CONFIG",
            "1 = HKEY_USERS",
            "2 = HKEY_LOCAL_MACHINE",
            "3 = HKEY_CLASSES_ROOT"
          ],
          "path": "text",
          "regType": [
            "0 = REG_SZ",
            "1 = REG_DWORD",
            "2 = REG_QWORD",
            "3 = REG_MULTI_SZ",
            "4 = REG_EXPAND_SZ"
          ],
          "stringValue": "text"
        }
      ]
    },
    "uwpApps": {
      "allExcept": [
        "text"
      ],
      "followingPkgs": [
        "text"
      ],
      "removeType": [
        "0 = AllExcept",
        "1 = FollowingPkgs"
      ]
    }
  },
  "licenseKeys": {
    "licenseKeyType": [
      "0 = KMS",
      "1 = MAK"
    ],
    "keys": [
      {
        "licenseKey": "text",
        "keyLimit": 1
      }
    ]
  }
}

Update

put

Modifies the settings of a RAS Template.

Path parameters

idinteger · int32Required

The ID of a RAS Template to modify.

Body

descriptionstring | nullableOptional

RAS Template Description.

folderNamestring | nullableOptional

Folder name where desktop VMs will be created.

folderIdstring | nullableOptional

The ID of a folder where desktop VMs will be created.

subFolderNamestring | nullableOptional

Subfolder name where desktop VMs will be created.

nativePoolIdstring | nullableOptional

The ID of the native pool where desktop VMs will be created.

nativePoolNamestring | nullableOptional

The name of the native pool where desktop VMs will be created.

hwgpuboolean | nullableOptional

Enable hardware acceleration graphics licensing support.

physicalHostIdstring | nullableOptional

The ID of a physical host where desktop VMs will be created.

physicalHostNamestring | nullableOptional

The name of a physical host where desktop VMs will be created.

useSeperateNetworkInterfaceboolean | nullableOptional

Use a separate network interface for LAN access.

addressstring | nullableOptional

The address of the network interface.

subnetMaskstring | nullableOptional

The subnet mask of the network interface.

instanceTypestring | nullableOptional

Instance type.

deviceNamestring | nullableOptional

Device name.

volumeTypestring · enumOptional

Volume type

Possible values:

sizeinteger · int64 | nullableOptional

Size (GiB).

maximumIOPSinteger · int64 | nullableOptional

Maximum IOPS.

throughputinteger · int64 | nullableOptional

Throughput (MB/s).

resourceGroupstring | nullableOptional

Resource group.

vmSizestring | nullableOptional

VM size.

osDiskTypestring · enumOptional

Volume type

Possible values:

virtualNetworkIDstring | nullableOptional

Virtual network ID.

virtualNetworkNamestring | nullableOptional

Virtual network name.

subnetIDstring | nullableOptional

Subnet ID.

subnetNamestring | nullableOptional

Subnet name.

imagePrepToolstring · enumOptional

Image preparation tool

Possible values:

computerNamestring | nullableOptional

The FQDN or IP address of the target VM.

ownerNamestring | nullableOptional

A desktop VM owner name (assigned to a VM by RASprep or Sysprep).

organizationstring | nullableOptional

Organization name (assigned to a VM by RASprep or Sysprep).

domainstring | nullableOptional

Domain or WorkGroup to join (assigned to a VM by RASprep or Sysprep).

domainPasswordstring | nullableOptional

The password of the domain administrator specified in the Administrator parameter.

administratorstring | nullableOptional

The administrator of the domain specified in the JoinDomain parameter.

adminPasswordstring | nullableOptional

The password of the administrator for the desktop VM (assigned to a VM by RASprep or Sysprep).

domainOrgUnitstring | nullableOptional

Domain Organization unit

inheritDefaultOptimizationSettingsboolean | nullableOptional

If true, default Optimization settings will be inherited.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "description": "text",
  "folderName": "text",
  "folderId": "text",
  "subFolderName": "text",
  "nativePoolId": "text",
  "nativePoolName": "text",
  "hwgpu": true,
  "physicalHostId": "text",
  "physicalHostName": "text",
  "useSeperateNetworkInterface": true,
  "address": "text",
  "subnetMask": "text",
  "instanceType": "text",
  "deviceName": "text",
  "volumeType": [
    "0 = gp2",
    "1 = gp3",
    "2 = io1",
    "3 = io2",
    "4 = standard"
  ],
  "size": 1,
  "maximumIOPS": 1,
  "throughput": 1,
  "resourceGroup": "text",
  "vmSize": "text",
  "osDiskType": [
    "1 = StandardHDD",
    "2 = StandardSSD",
    "4 = PremiumSSD"
  ],
  "virtualNetworkID": "text",
  "virtualNetworkName": "text",
  "subnetID": "text",
  "subnetName": "text",
  "imagePrepTool": [
    "0 = SysPrep",
    "1 = RASPrep"
  ],
  "computerName": "text",
  "ownerName": "text",
  "organization": "text",
  "domain": "text",
  "domainPassword": "text",
  "administrator": "text",
  "adminPassword": "text",
  "domainOrgUnit": "text",
  "inheritDefaultOptimizationSettings": true
}

No content

Add

post

Adds a Windows Component Custom to optimization.

Path parameters

idinteger · int32Required

The ID of the Optimization settings to add the windows component custom.

Body

aliasesstring | nullableOptional

Windows Components Alias

displayNamestring | nullableOptional

Windows Components Diplay Name

componentNamestring | nullableOptional

Windows Components Name

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/Optimization/WindowsComponent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 62

{
  "aliases": "text",
  "displayName": "text",
  "componentName": "text"
}

No content

Delete

delete

Removes Windows Component Custom From Optimization.

Path parameters

idinteger · int32Required

The ID of the optimization setting to remove the windows component custom.

Body

componentNamestring | nullableOptional

Windows Component Name

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/Template/{id}/Optimization/WindowsComponent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 24

{
  "componentName": "text"
}

No content

Create

post

Creates a new Azure Virtual Desktop Resource Group.

Body

providerIdinteger · int32Required

Provider ID from which to save the Azure Virtual Desktop Resource Group information.

namestring | nullableRequired

The Name of the Azure Virtual Desktop Resource Group.

locationstring | nullableRequired

The Location Name of the Azure Virtual Desktop Resource Group.

Responses

204

No Content

400

Bad Request

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

post

POST /api/AVD/ResourceGroup HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 48

{
  "providerId": 1,
  "name": "text",
  "location": "text"
}

No content

Add

post

Adds Registry to the optimization.

Path parameters

idinteger · int32Required

The ID of the optimization to retrieve the registry.

Body

actionstring · enumOptional

The action type for add registry entry

Possible values:

registryNamestring | nullableOptional

Name

dwordValueinteger · int32Optional

Value

displayNamestring | nullableRequired

Display Name

hiveTypestring · enumOptional

The hive type for add registry entry

Possible values:

pathstring | nullableRequired

Path

regTypestring · enumOptional

The value type for add registry entry

Possible values:

stringValuestring | nullableOptional

String Value

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/Optimization/Registry HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 342

{
  "action": [
    "0 = Add",
    "1 = Modify",
    "2 = Delete"
  ],
  "registryName": "text",
  "dwordValue": 1,
  "displayName": "text",
  "hiveType": [
    "0 = HKEY_CURRENT_CONFIG",
    "1 = HKEY_USERS",
    "2 = HKEY_LOCAL_MACHINE",
    "3 = HKEY_CLASSES_ROOT"
  ],
  "path": "text",
  "regType": [
    "0 = REG_SZ",
    "1 = REG_DWORD",
    "2 = REG_QWORD",
    "3 = REG_MULTI_SZ",
    "4 = REG_EXPAND_SZ"
  ],
  "stringValue": "text"
}

No content

Delete

delete

Remove Registry Image Optimization Object.

Path parameters

idinteger · int32Required

Id Of the Optimization Settings to remove the registry object.

Body

registryIdinteger · int32Required

Registry Id

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/Template/{id}/Optimization/Registry HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 16

{
  "registryId": 1
}

No content

Update

put

Update the Image Optimization settings with the specified ID.

Path parameters

idinteger · int32Required

The ID for which to modify the Image Optimization.

Body

enableOptimizationboolean | nullableOptional

Whether Optimization is Enabled or not

optimizationTypestring · enumOptional

Optimization Type

Possible values:

windowsDefenderATPEnabledboolean | nullableOptional

Whether Windows Defender ATP is enabled or not

windowsComponentsEnabledboolean | nullableOptional

Whether Windows Components is enabled or not

windowsServicesEnabledboolean | nullableOptional

Whether Windows Services is enabled or not

windowsScheduledTasksEnabledboolean | nullableOptional

Whether Windows Scheduled Task is enabled or not

windowsAdvancedOptionsEnabledboolean | nullableOptional

Whether Windows Advanced Options is enabled or not

networkPerformanceEnabledboolean | nullableOptional

Whether Network Performance is enabled or not

registryEnabledboolean | nullableOptional

Whether Registry is enabled or not

visualEffectsEnabledboolean | nullableOptional

Whether Visual Effects is enabled or not

diskCleanupEnabledboolean | nullableOptional

Whether Disk Cleanup is enabled or not

customScriptEnabledboolean | nullableOptional

Whether Custom Script is enabled or not

winDefATPTurnOffOnstring · enumOptional

Windows enable options

Possible values:

disableRealTimeProtectionboolean | nullableOptional

Disable Real Time Protection

excludeFoldersstring[] | nullableOptional

Exclude Folders List

excludeProcessesstring[] | nullableOptional

Exclude Processes

excludeExtensionstring[] | nullableOptional

Exclude Extensions

partialStartLayoutContentstring | nullableOptional

Partial Start menu layout

hibernateboolean | nullableOptional

Whether Hibernate is enabled or not

teleCollectionboolean | nullableOptional

Whether TeleCollection is enabled or not

systemRestoreboolean | nullableOptional

Whether System Restore is enabled or not

additionalErrorReportboolean | nullableOptional

Whether Additional Error Reporting is enabled or not

tilesboolean | nullableOptional

Whether Tiles is enabled or not

cortanaboolean | nullableOptional

Whether Cortana is enabled or not

microsoftConsumerExperienceboolean | nullableOptional

Whether Microsoft Consumer Experience is enabled or not

windowsTipsboolean | nullableOptional

Whether Windows Tips is enabled or not

commonProgramGroupsboolean | nullableOptional

Whether Common Program Groups is enabled or not

partialStartMenuboolean | nullableOptional

Whether Partial Start Menu is enabled or not

dirCacheMaxinteger · int32 | nullableOptional

Directory Cache Value

dormantFileLimitinteger · int32 | nullableOptional

Dormant File Limit Value

fileNotFoundCacheinteger · int32 | nullableOptional

File Not Found Cache Value

fileInfoCacheinteger · int32 | nullableOptional

File Info Cache Value

fileInfoCacheEnableboolean | nullableOptional

Whether File Info Cache is enabled or not

directoryCacheEnableboolean | nullableOptional

Whether Directory Cache is enabled or not

fileNotFoundCacheEnableboolean | nullableOptional

Whether File Not Found Cache is enabled or not

dormantFileLimitEnableboolean | nullableOptional

Whether Dormant File Limit is enabled or not

disableTCPboolean | nullableOptional

Whether Disable TCP is enabled or not

disableIPv6CompEnableboolean | nullableOptional

Whether Disable IPv6 Components is enabled or not

disableIPv6ToIPv4boolean | nullableOptional

Whether Disable IPv6 To IPv4 is enabled or not

disableIsaTapboolean | nullableOptional

Whether Disable IsaTap for IPv6 is enabled or not

argumentsstring | nullableOptional

Arguments

commandstring | nullableOptional

Command

initDirstring | nullableOptional

Initial Directory

userstring | nullableOptional

User

passwordstring | nullableOptional

Password

cleanupWinSxSFolderboolean | nullableOptional

Whether Clean up windows SxS Folder is enabled or not

cleanupSystemFilesboolean | nullableOptional

Whether Clean up system files is enabled or not

cleanupTemporaryFileLogsboolean | nullableOptional

Whether Clean up temporary file logs is enabled or not

removeOneDriveboolean | nullableOptional

Whether Remove One Drives is enabled or not

deleteUserProfilesboolean | nullableOptional

Whether Delete User Profiles is enabled or not

visualEffectsTypesstring · enumOptional

Visual Effects Type

Possible values:

animateControlSelectElementsboolean | nullableOptional

Whether Animate Control Select Elements is enabled or not

animateWindowsWhenMinimizingMaximizingboolean | nullableOptional

Whether Animate Windows When Minimizing Or Maximizing is enabled or not

animateTaskbarboolean | nullableOptional

Whether Animate Taskbar is enabled or not

enablePeekboolean | nullableOptional

Whether Peek is enabled or not

fadeSlideMenusboolean | nullableOptional

Whether Fade Slide Menus is enabled or not

fadeSlideToolTipsboolean | nullableOptional

Whether Fade Slide Tool Tips is enabled or not

fadeOutMenuItemsboolean | nullableOptional

Whether Fade Out Menu Items is enabled or not

saveTaskbarThumbnailboolean | nullableOptional

Whether Taskbar Thumbnail is enabled or not

showShadowUnderMouseboolean | nullableOptional

Whether Shadow Under Mouse is enabled or not

shadowUnderWindowsboolean | nullableOptional

Whether Shadow Under Windows is enabled or not

thumbnailsInsteadOfIconsboolean | nullableOptional

Whether Thumbnails instead of icons is enabled or not

showTranslucentSelectionboolean | nullableOptional

Whether Translucent Selection is enabled or not

showWindowsContentWhilstDraggingboolean | nullableOptional

Whether Windows Content Whilst Dragging is enabled or not

slideOpenComboBoxesboolean | nullableOptional

Whether Slide open combo boxes is enabled or not

smoothEdgesScreenFontsboolean | nullableOptional

Whether Smooth Edges Screen Fonts is enabled or not

smoothScrollListBoxesboolean | nullableOptional

Whether Smooth Scroll List Boxes is enabled or not

dropShadowsIconboolean | nullableOptional

Whether Drop Shadow Icon is enabled or not

forcebooleanOptional

Force Optimization.

Default: false

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

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

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "winDefATPTurnOffOn": [
    "0 = TurnOffWindowsDefenderATP",
    "1 = TurnOnWindowsDefenderATP"
  ],
  "disableRealTimeProtection": true,
  "excludeFolders": [
    "text"
  ],
  "excludeProcesses": [
    "text"
  ],
  "excludeExtension": [
    "text"
  ],
  "partialStartLayoutContent": "text",
  "hibernate": true,
  "teleCollection": true,
  "systemRestore": true,
  "additionalErrorReport": true,
  "tiles": true,
  "cortana": true,
  "microsoftConsumerExperience": true,
  "windowsTips": true,
  "commonProgramGroups": true,
  "partialStartMenu": true,
  "dirCacheMax": 1,
  "dormantFileLimit": 1,
  "fileNotFoundCache": 1,
  "fileInfoCache": 1,
  "fileInfoCacheEnable": true,
  "directoryCacheEnable": true,
  "fileNotFoundCacheEnable": true,
  "dormantFileLimitEnable": true,
  "disableTCP": true,
  "disableIPv6CompEnable": true,
  "disableIPv6ToIPv4": true,
  "disableIsaTap": true,
  "arguments": "text",
  "command": "text",
  "initDir": "text",
  "user": "text",
  "password": "text",
  "cleanupWinSxSFolder": true,
  "cleanupSystemFiles": true,
  "cleanupTemporaryFileLogs": true,
  "removeOneDrive": true,
  "deleteUserProfiles": true,
  "visualEffectsTypes": [
    "0 = LetWindowsChooseWhatsBest",
    "1 = AdjustForBestAppearance",
    "2 = AdjustForBestPerformance",
    "3 = Custom"
  ],
  "animateControlSelectElements": true,
  "animateWindowsWhenMinimizingMaximizing": true,
  "animateTaskbar": true,
  "enablePeek": true,
  "fadeSlideMenus": true,
  "fadeSlideToolTips": true,
  "fadeOutMenuItems": true,
  "saveTaskbarThumbnail": true,
  "showShadowUnderMouse": true,
  "shadowUnderWindows": true,
  "thumbnailsInsteadOfIcons": true,
  "showTranslucentSelection": true,
  "showWindowsContentWhilstDragging": true,
  "slideOpenComboBoxes": true,
  "smoothEdgesScreenFonts": true,
  "smoothScrollListBoxes": true,
  "dropShadowsIcon": true,
  "force": true
}

No content

Add

post

Adds a Windows Scheduled task to optimization.

Path parameters

idinteger · int32Required

The ID of the Optimization settings to retrieve the windows scheduled task.

Body

taskstring | nullableRequired

Scheduled Task Name

locationstring | nullableRequired

Scheduled Task Location

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33

{
  "task": "text",
  "location": "text"
}

No content

Delete

delete

Removes Windows Scheduled Task From Optimization.

Path parameters

idinteger · int32Required

The ID of the optimization setting to remove the windows scheduled task.

Body

taskstring | nullableRequired

Scheduled Task

locationstring | nullableRequired

Scheduled Task Location

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/Template/{id}/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33

{
  "task": "text",
  "location": "text"
}

No content

Update Version

put

Modify properties of a RAS Template version.

Path parameters

idinteger · int32Required

The ID of a RAS Template

VersionIdinteger · int32Required

The ID of a RAS Template Version

Body

newNamestring | nullableOptional

Template version name.

descriptionstring | nullableOptional

Template version description

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/Template/{id}/Version/{VersionId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 39

{
  "newName": "text",
  "description": "text"
}

No content

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-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "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

Import

post

Creates an Azure Virtual Desktop Workspace from an existing Workspace.

Body

To import an existing AVD 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.

azureIdstring | nullableRequired

Azure ID of existing 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/Existing HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 44

{
  "siteId": 1,
  "providerId": 1,
  "azureId": "text"
}

{
  "id": 1,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2025-05-09T04:40:27.458Z",
  "timeLastMod": "2025-05-09T04:40:27.458Z",
  "providerId": 1,
  "name": "text",
  "enabled": true,
  "friendlyName": "text",
  "description": "text",
  "resourceGroup": "text",
  "location": "text",
  "azureId": "text"
}

Update

put

Update the Azure Virtaul Desktop default settings.

Query parameters

SiteIdinteger · int32Optional

The site id for which to modify the Azure Virtaul Desktop default settings.

Body

technologystring · enumOptional

User Profile Technology values.

Possible values:

disconnectActiveSessionAfterinteger · int32 | nullableOptional

Disconnect active session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'.

logoffDisconnectedSessionAfterinteger · int32 | nullableOptional

Logoff disconnected session after (in seconds). Accepted values: 20-1641600 seconds; 0 for 'Never'; 1 for 'Immediate'.

sessionReadinessTimeoutinteger · int32 | nullableOptional

Session readiness timeout (in seconds). Accepted values: 20-3600 seconds.

allowRemoteExecboolean | nullableOptional

Specifies if 'Allow 2XRemoteExec to send command to the client' option is enabled or disabled.

allowURLAndMailRedirectionstring · enumOptional

URL and Mail Redirection values.

Possible values:

supportShellURLNamespaceObjectsboolean | nullableOptional

Specifies if 'Support Shell URL Namespace Objects' option is enabled or disabled.

manageRDPTransportProtocolstring · enumOptional

Manage RDP transport protocol.

Possible values:

manageRDPShortpathboolean | nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

appMonitorboolean | nullableOptional

Specifies if 'Allow Application Monitoring' option is enabled or disabled.

useRDPShortpathboolean | nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

useSmallerPortRangeboolean | nullableOptional

Specifies if 'Use Smaller Port' option is enabled or disabled.

minRDPShortpathPortinteger · int32 | nullableOptional

The minimum RDP Shortpath Port.

maxRDPShortpathPortinteger · int32 | nullableOptional

The maximum RDP Shortpath Port.

dragAndDropModestring · enumOptional

Drag and drop redirection values.

Possible values:

fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:

fileTransferLocationstring | nullableOptional

Location where the File Transfer takes place, if and where it is allowed.

fileTransferLockLocationboolean | nullableOptional

Lock Location where the File Transfer takes place, if and where it is allowed.

enableDriveRedirectionCacheboolean | nullableOptional

Specifies if the 'Enable Drive Redirection Cache' option is enabled or disabled.

sessionActionstring · enumOptional

Session Action type

Possible values:

performActionstring · enumOptional

Perform Action type

Possible values:

performActionAfterSecinteger · int32 | nullableOptional

Perform action after (in seconds)

printerNameFormatstring · enumOptional

Printer Name Format

Possible values:

removeSessionNumberFromPrinterNameboolean | nullableOptional

Specifies if 'Remove session number from printer name' option is enabled or disabled.

removeClientNameFromPrinterNameboolean | nullableOptional

Specifies if 'Remove client name from printer name' option is enabled or disabled.

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/DefaultSettings/MultiSession HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1220

{
  "technology": [
    "0 = DoNotManage",
    "1 = UPD",
    "2 = FSLogix"
  ],
  "disconnectActiveSessionAfter": 1,
  "logoffDisconnectedSessionAfter": 1,
  "sessionReadinessTimeout": 1,
  "allowRemoteExec": true,
  "allowURLAndMailRedirection": [
    "0 = Disabled",
    "1 = Enabled",
    "2 = EnabledWithAppRegistration"
  ],
  "supportShellURLNamespaceObjects": true,
  "manageRDPTransportProtocol": [
    "0 = Disabled",
    "1 = BothUDPTCP",
    "2 = OnlyTCP",
    "3 = EitherUDPTCP"
  ],
  "manageRDPShortpath": true,
  "appMonitor": true,
  "useRDPShortpath": true,
  "useSmallerPortRange": true,
  "minRDPShortpathPort": 1,
  "maxRDPShortpathPort": 1,
  "dragAndDropMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferMode": [
    "0 = Disabled",
    "1 = ClientToServer",
    "2 = ServerToClient",
    "3 = Bidirectional"
  ],
  "fileTransferLocation": "text",
  "fileTransferLockLocation": true,
  "enableDriveRedirectionCache": true,
  "sessionAction": [
    "0 = Disconnect",
    "1 = Logoff"
  ],
  "performAction": [
    "0 = DoNothing",
    "2 = Shutdown",
    "4 = Suspend",
    "7 = Delete",
    "8 = Restart",
    "9 = Unassign",
    "10 = Recreate"
  ],
  "performActionAfterSec": 1,
  "printerNameFormat": [
    "0 = PrnFormat_PRN_CMP_SES",
    "1 = PrnFormat_SES_CMP_PRN",
    "2 = PrnFormat_PRN_REDSES"
  ],
  "removeSessionNumberFromPrinterName": true,
  "removeClientNameFromPrinterName": true
}

No content

Add

post

Adds Registry to the default optimization.

Query parameters

siteIdinteger · int32Optional

The Site Id of the optimization to retrieve the registry.

Body

actionstring · enumOptional

The action type for add registry entry

Possible values:

registryNamestring | nullableOptional

Name

dwordValueinteger · int32Optional

Value

displayNamestring | nullableRequired

Display Name

hiveTypestring · enumOptional

The hive type for add registry entry

Possible values:

pathstring | nullableRequired

Path

regTypestring · enumOptional

The value type for add registry entry

Possible values:

stringValuestring | nullableOptional

String Value

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/Optimization/Registry HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 342

{
  "action": [
    "0 = Add",
    "1 = Modify",
    "2 = Delete"
  ],
  "registryName": "text",
  "dwordValue": 1,
  "displayName": "text",
  "hiveType": [
    "0 = HKEY_CURRENT_CONFIG",
    "1 = HKEY_USERS",
    "2 = HKEY_LOCAL_MACHINE",
    "3 = HKEY_CLASSES_ROOT"
  ],
  "path": "text",
  "regType": [
    "0 = REG_SZ",
    "1 = REG_DWORD",
    "2 = REG_QWORD",
    "3 = REG_MULTI_SZ",
    "4 = REG_EXPAND_SZ"
  ],
  "stringValue": "text"
}

No content

Delete

delete

Remove Default Registry Image Optimization Object.

Query parameters

siteIdinteger · int32Optional

The Site Id of the Optimization Settings to remove the registry object.

Body

registryIdinteger · int32Required

Registry Id

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/Optimization/Registry HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 16

{
  "registryId": 1
}

No content

Add

post

Adds a default Windows Component Custom to optimization.

Query parameters

siteIDinteger · int32Optional

The site ID of the Optimization settings to retrieve the windows component custom.

Body

aliasesstring | nullableOptional

Windows Components Alias

displayNamestring | nullableOptional

Windows Components Diplay Name

componentNamestring | nullableOptional

Windows Components Name

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsComponent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 62

{
  "aliases": "text",
  "displayName": "text",
  "componentName": "text"
}

No content

Delete

delete

Removes Default Windows Component Custom From Optimization.

Query parameters

siteIDinteger · int32Optional

The Site ID of the optimization setting to remove the windows component custom.

Body

componentNamestring | nullableOptional

Windows Component Name

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsComponent HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 24

{
  "componentName": "text"
}

No content

Add

post

Adds a default Windows Service Custom to optimization.

Query parameters

siteIDinteger · int32Optional

The Site ID of the Optimization settings to retrieve the windows services custom.

Body

aliasesstring | nullableOptional

Windows Services Alias

displayNamestring | nullableOptional

Windows Services Diplay Name

serviceNamestring | nullableOptional

Windows Service Name

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsService HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 60

{
  "aliases": "text",
  "displayName": "text",
  "serviceName": "text"
}

No content

Delete

delete

Removes Default Windows Service Custom From Optimization.

Query parameters

siteIDinteger · int32Optional

The ID of the optimization setting to remove the windows Service custom.

Body

serviceNamestring | nullableOptional

Windows Service Name

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsService HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "serviceName": "text"
}

No content

Update

put

Update the Auto-upgrade settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to modify the Auto-upgrade settings (optional).

Body

objectOptional

Modify the Auto-upgrade settings

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/AutoUpgrade HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 2

{}

No content

Add

post

Add a default assigned application package.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to add the assigned application package.

Body

packageNamestring | nullableRequired

The application package name. This must be the actual application package name used in the RAS farm.

versionstring | nullableRequired

The version of the application package. This must be the actual application package version used in the RAS farm.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/AppPackageAssigned HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 39

{
  "packageName": "text",
  "version": "text"
}

No content

Update

put

Update the default assigned application package settings with the specified Site ID.

Query parameters

siteIdinteger · int32Optional

The Site ID for which to modify the default assigned application package.

Body

packageNamestring | nullableRequired

The name of the application package for which to change the version. This must be the actual application package name used in the RAS farm.

versionstring | nullableRequired

The new version of the application package. This must be the actual application package version used in the RAS farm.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/AppPackageAssigned HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 39

{
  "packageName": "text",
  "version": "text"
}

No content

Delete

delete

Remove the default assigned application package.

Query parameters

siteIdinteger · int32Optional

Site ID for which to remove the assigned application package.

Body

packageNamestring | nullableRequired

The name of the application package for which to remove the assigned packaged application. This must be the actual application package name used in the RAS farm.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/AppPackageAssigned HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "packageName": "text"
}

No content

Update

put

Update the Default Image Optimization settings with the specified Site ID.

Query parameters

siteIdinteger · int32Optional

The Site Id for which to modify the Image Optimization.

Body

enableOptimizationboolean | nullableOptional

Whether Optimization is Enabled or not

optimizationTypestring · enumOptional

Optimization Type

Possible values:

windowsDefenderATPEnabledboolean | nullableOptional

Whether Windows Defender ATP is enabled or not

windowsComponentsEnabledboolean | nullableOptional

Whether Windows Components is enabled or not

windowsServicesEnabledboolean | nullableOptional

Whether Windows Services is enabled or not

windowsScheduledTasksEnabledboolean | nullableOptional

Whether Windows Scheduled Task is enabled or not

windowsAdvancedOptionsEnabledboolean | nullableOptional

Whether Windows Advanced Options is enabled or not

networkPerformanceEnabledboolean | nullableOptional

Whether Network Performance is enabled or not

registryEnabledboolean | nullableOptional

Whether Registry is enabled or not

visualEffectsEnabledboolean | nullableOptional

Whether Visual Effects is enabled or not

diskCleanupEnabledboolean | nullableOptional

Whether Disk Cleanup is enabled or not

customScriptEnabledboolean | nullableOptional

Whether Custom Script is enabled or not

winDefATPTurnOffOnstring · enumOptional

Windows enable options

Possible values:

disableRealTimeProtectionboolean | nullableOptional

Disable Real Time Protection

excludeFoldersstring[] | nullableOptional

Exclude Folders List

excludeProcessesstring[] | nullableOptional

Exclude Processes

excludeExtensionstring[] | nullableOptional

Exclude Extensions

partialStartLayoutContentstring | nullableOptional

Partial Start menu layout

hibernateboolean | nullableOptional

Whether Hibernate is enabled or not

teleCollectionboolean | nullableOptional

Whether TeleCollection is enabled or not

systemRestoreboolean | nullableOptional

Whether System Restore is enabled or not

additionalErrorReportboolean | nullableOptional

Whether Additional Error Reporting is enabled or not

tilesboolean | nullableOptional

Whether Tiles is enabled or not

cortanaboolean | nullableOptional

Whether Cortana is enabled or not

microsoftConsumerExperienceboolean | nullableOptional

Whether Microsoft Consumer Experience is enabled or not

windowsTipsboolean | nullableOptional

Whether Windows Tips is enabled or not

commonProgramGroupsboolean | nullableOptional

Whether Common Program Groups is enabled or not

partialStartMenuboolean | nullableOptional

Whether Partial Start Menu is enabled or not

dirCacheMaxinteger · int32 | nullableOptional

Directory Cache Value

dormantFileLimitinteger · int32 | nullableOptional

Dormant File Limit Value

fileNotFoundCacheinteger · int32 | nullableOptional

File Not Found Cache Value

fileInfoCacheinteger · int32 | nullableOptional

File Info Cache Value

fileInfoCacheEnableboolean | nullableOptional

Whether File Info Cache is enabled or not

directoryCacheEnableboolean | nullableOptional

Whether Directory Cache is enabled or not

fileNotFoundCacheEnableboolean | nullableOptional

Whether File Not Found Cache is enabled or not

dormantFileLimitEnableboolean | nullableOptional

Whether Dormant File Limit is enabled or not

disableTCPboolean | nullableOptional

Whether Disable TCP is enabled or not

disableIPv6CompEnableboolean | nullableOptional

Whether Disable IPv6 Components is enabled or not

disableIPv6ToIPv4boolean | nullableOptional

Whether Disable IPv6 To IPv4 is enabled or not

disableIsaTapboolean | nullableOptional

Whether Disable IsaTap for IPv6 is enabled or not

argumentsstring | nullableOptional

Arguments

commandstring | nullableOptional

Command

initDirstring | nullableOptional

Initial Directory

userstring | nullableOptional

User

passwordstring | nullableOptional

Password

cleanupWinSxSFolderboolean | nullableOptional

Whether Clean up windows SxS Folder is enabled or not

cleanupSystemFilesboolean | nullableOptional

Whether Clean up system files is enabled or not

cleanupTemporaryFileLogsboolean | nullableOptional

Whether Clean up temporary file logs is enabled or not

removeOneDriveboolean | nullableOptional

Whether Remove One Drives is enabled or not

deleteUserProfilesboolean | nullableOptional

Whether Delete User Profiles is enabled or not

visualEffectsTypesstring · enumOptional

Visual Effects Type

Possible values:

animateControlSelectElementsboolean | nullableOptional

Whether Animate Control Select Elements is enabled or not

animateWindowsWhenMinimizingMaximizingboolean | nullableOptional

Whether Animate Windows When Minimizing Or Maximizing is enabled or not

animateTaskbarboolean | nullableOptional

Whether Animate Taskbar is enabled or not

enablePeekboolean | nullableOptional

Whether Peek is enabled or not

fadeSlideMenusboolean | nullableOptional

Whether Fade Slide Menus is enabled or not

fadeSlideToolTipsboolean | nullableOptional

Whether Fade Slide Tool Tips is enabled or not

fadeOutMenuItemsboolean | nullableOptional

Whether Fade Out Menu Items is enabled or not

saveTaskbarThumbnailboolean | nullableOptional

Whether Taskbar Thumbnail is enabled or not

showShadowUnderMouseboolean | nullableOptional

Whether Shadow Under Mouse is enabled or not

shadowUnderWindowsboolean | nullableOptional

Whether Shadow Under Windows is enabled or not

thumbnailsInsteadOfIconsboolean | nullableOptional

Whether Thumbnails instead of icons is enabled or not

showTranslucentSelectionboolean | nullableOptional

Whether Translucent Selection is enabled or not

showWindowsContentWhilstDraggingboolean | nullableOptional

Whether Windows Content Whilst Dragging is enabled or not

slideOpenComboBoxesboolean | nullableOptional

Whether Slide open combo boxes is enabled or not

smoothEdgesScreenFontsboolean | nullableOptional

Whether Smooth Edges Screen Fonts is enabled or not

smoothScrollListBoxesboolean | nullableOptional

Whether Smooth Scroll List Boxes is enabled or not

dropShadowsIconboolean | nullableOptional

Whether Drop Shadow Icon is enabled or not

forcebooleanOptional

Force Optimization.

Default: false

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/Optimization HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1974

{
  "enableOptimization": true,
  "optimizationType": [
    "0 = Automatic",
    "1 = Manual"
  ],
  "windowsDefenderATPEnabled": true,
  "windowsComponentsEnabled": true,
  "windowsServicesEnabled": true,
  "windowsScheduledTasksEnabled": true,
  "windowsAdvancedOptionsEnabled": true,
  "networkPerformanceEnabled": true,
  "registryEnabled": true,
  "visualEffectsEnabled": true,
  "diskCleanupEnabled": true,
  "customScriptEnabled": true,
  "winDefATPTurnOffOn": [
    "0 = TurnOffWindowsDefenderATP",
    "1 = TurnOnWindowsDefenderATP"
  ],
  "disableRealTimeProtection": true,
  "excludeFolders": [
    "text"
  ],
  "excludeProcesses": [
    "text"
  ],
  "excludeExtension": [
    "text"
  ],
  "partialStartLayoutContent": "text",
  "hibernate": true,
  "teleCollection": true,
  "systemRestore": true,
  "additionalErrorReport": true,
  "tiles": true,
  "cortana": true,
  "microsoftConsumerExperience": true,
  "windowsTips": true,
  "commonProgramGroups": true,
  "partialStartMenu": true,
  "dirCacheMax": 1,
  "dormantFileLimit": 1,
  "fileNotFoundCache": 1,
  "fileInfoCache": 1,
  "fileInfoCacheEnable": true,
  "directoryCacheEnable": true,
  "fileNotFoundCacheEnable": true,
  "dormantFileLimitEnable": true,
  "disableTCP": true,
  "disableIPv6CompEnable": true,
  "disableIPv6ToIPv4": true,
  "disableIsaTap": true,
  "arguments": "text",
  "command": "text",
  "initDir": "text",
  "user": "text",
  "password": "text",
  "cleanupWinSxSFolder": true,
  "cleanupSystemFiles": true,
  "cleanupTemporaryFileLogs": true,
  "removeOneDrive": true,
  "deleteUserProfiles": true,
  "visualEffectsTypes": [
    "0 = LetWindowsChooseWhatsBest",
    "1 = AdjustForBestAppearance",
    "2 = AdjustForBestPerformance",
    "3 = Custom"
  ],
  "animateControlSelectElements": true,
  "animateWindowsWhenMinimizingMaximizing": true,
  "animateTaskbar": true,
  "enablePeek": true,
  "fadeSlideMenus": true,
  "fadeSlideToolTips": true,
  "fadeOutMenuItems": true,
  "saveTaskbarThumbnail": true,
  "showShadowUnderMouse": true,
  "shadowUnderWindows": true,
  "thumbnailsInsteadOfIcons": true,
  "showTranslucentSelection": true,
  "showWindowsContentWhilstDragging": true,
  "slideOpenComboBoxes": true,
  "smoothEdgesScreenFonts": true,
  "smoothScrollListBoxes": true,
  "dropShadowsIcon": true,
  "force": true
}

No content

Add

post

Adds a Windows Scheduled task to default optimization.

Query parameters

siteIdinteger · int32Optional

The Site Id of the Optimization settings to retrieve the windows scheduled task.

Body

taskstring | nullableRequired

Scheduled Task Name

locationstring | nullableRequired

Scheduled Task Location

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33

{
  "task": "text",
  "location": "text"
}

No content

Delete

delete

Removes Default Windows Scheduled Task From Optimization.

Query parameters

siteIdinteger · int32Optional

The Site Id of the optimization setting to remove the windows scheduled task.

Body

taskstring | nullableRequired

Scheduled Task

locationstring | nullableRequired

Scheduled Task Location

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/Optimization/WindowsScheduledTask HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 33

{
  "task": "text",
  "location": "text"
}

No content

Create

post

Create an Auto-upgrade Message.

Body

Add a message to the Auto-upgrade message list

enabledbooleanOptional

Whether to enable or disable the message.

messageTitlestring | nullableRequired

The title of the message.

messagestring | nullableRequired

A message that should be sent to users before the job starts.

sendMsgSecsinteger · int32Optional

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenstring · enumOptional

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

{
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

No content

Update

put

Update an Auto-upgrade Message.

Path parameters

messageIdinteger · int32Required

The ID of the message to modify.

Body

Modify a message within the Auto-upgrade message list

enabledboolean | nullableOptional

Whether to enable or disable the message.

messageTitlestring | nullableOptional

The title of the message.

messagestring | nullableOptional

A message that should be sent to users before the job starts.

sendMsgSecsinteger · int32 | nullableOptional

Time interval in seconds before the job starts when the message to users should be sent.

sendMsgWhenstring · enumOptional

Whether the message is sent Before/After the schedule is triggered. Send Message When can only be set to After in the case of Reboot.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/AutoUpgrade/Messages/{messageId} HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 112

{
  "enabled": true,
  "messageTitle": "text",
  "message": "text",
  "sendMsgSecs": 1,
  "sendMsgWhen": [
    "0 = Before",
    "1 = After"
  ]
}

No content

Update

put

Update the FSLogix Office Container settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

officeContainerEnabledboolean | nullableOptional

Specifies if the Office Container is enabled or disabled.

locationTypestring · enumOptional

Location Type values.

Possible values:

vhdLocationsstring[] | nullableOptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] | nullableOptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumOptional

Profile Disk Format values.

Possible values:

allocationTypestring · enumOptional

Allocation Type values.

Possible values:

defaultSizeinteger · int32 | nullableOptional

Specifies the 'Default size'.

useLockedRetryCountboolean | nullableOptional

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger · int32 | nullableOptional

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean | nullableOptional

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger · int32 | nullableOptional

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean | nullableOptional

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectstring · enumOptional

Enable State values.

Possible values:

useAttachVHDSDDLboolean | nullableOptional

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLstring | nullableOptional

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean | nullableOptional

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathstring | nullableOptional

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean | nullableOptional

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNamestring · enumOptional

Enable State values.

Possible values:

useNoProfileContainingFolderboolean | nullableOptional

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderstring · enumOptional

Enable State values.

Possible values:

useOutlookCachedModeboolean | nullableOptional

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithFailureboolean | nullableOptional

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailurestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithTempProfileboolean | nullableOptional

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfilestring · enumOptional

Enable State values.

Possible values:

useReAttachRetryCountboolean | nullableOptional

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger · int32 | nullableOptional

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean | nullableOptional

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger · int32 | nullableOptional

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean | nullableOptional

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamSearchboolean | nullableOptional

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchstring · enumOptional

Roam search values.

Possible values:

useSIDDirNameMatchboolean | nullableOptional

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchstring | nullableOptional

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean | nullableOptional

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternstring | nullableOptional

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean | nullableOptional

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLstring | nullableOptional

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean | nullableOptional

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchstring | nullableOptional

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean | nullableOptional

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternstring | nullableOptional

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean | nullableOptional

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizestring · enumOptional

Enable State values.

Possible values:

useVolumeWaitTimeMSboolean | nullableOptional

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger · int32 | nullableOptional

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean | nullableOptional

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDstring · enumOptional

Ignore non-AVD values.

Possible values:

useRedirectTypeboolean | nullableOptional

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypestring · enumOptional

Redirect type values.

Possible values:

useIncludeOfficeActivationboolean | nullableOptional

Specifies if the 'Include Office Activation' option is enabled or disabled.

includeOfficeActivationstring · enumOptional

Enable State values.

Possible values:

useIncludeOneDriveboolean | nullableOptional

Specifies if the 'Include OneDrive' option is enabled or disabled.

includeOneDrivestring · enumOptional

Enable State values.

Possible values:

useIncludeOneNoteboolean | nullableOptional

Specifies if the 'Include OneNote' option is enabled or disabled.

includeOneNotestring · enumOptional

Enable State values.

Possible values:

useIncludeOneNoteUWPboolean | nullableOptional

Specifies if the 'Include OneNote UWP' option is enabled or disabled.

includeOneNoteUWPstring · enumOptional

Enable State values.

Possible values:

useIncludeOutlookboolean | nullableOptional

Specifies if the 'Include Outlook' option is enabled or disabled.

includeOutlookstring · enumOptional

Enable State values.

Possible values:

useIncludeOutlookPersonalizationboolean | nullableOptional

Specifies if the 'Include Outlook Personalization' option is enabled or disabled.

includeOutlookPersonalizationstring · enumOptional

Enable State values.

Possible values:

useIncludeSharepointboolean | nullableOptional

Specifies if the 'Include Sharepoint' option is enabled or disabled.

includeSharepointstring · enumOptional

Enable State values.

Possible values:

useIncludeSkypeboolean | nullableOptional

Specifies if the 'Include Skype' option is enabled or disabled.

includeSkypestring · enumOptional

Enable State values.

Possible values:

useIncludeTeamsboolean | nullableOptional

Specifies if the 'Include Teams' option is enabled or disabled.

includeTeamsstring · enumOptional

Enable State values.

Possible values:

useMirrorLocalOSTToVHDboolean | nullableOptional

Specifies if the 'Mirror Local OST-VHD' option is enabled or disabled.

mirrorLocalOSTToVHDstring · enumOptional

Mirror Local OST-VHD values.

Possible values:

useNumSessionVHDsToKeepboolean | nullableOptional

Specifies if the 'Number of Session VHDs to Keep' option is enabled or disabled.

numSessionVHDsToKeepinteger · int32 | nullableOptional

Specifies the 'Number of Session VHDs to Keep'.

useOutlookFolderPathboolean | nullableOptional

Specifies if the 'Outlook Folder Path' option is enabled or disabled.

outlookFolderPathstring | nullableOptional

Specifies the 'Outlook Folder Path'.

useRefreshUserPolicyboolean | nullableOptional

Specifies if the 'Refresh User Policy' option is enabled or disabled.

refreshUserPolicystring · enumOptional

Enable State values.

Possible values:

useVHDAccessModeboolean | nullableOptional

Specifies if the 'VHD Access Mode' option is enabled or disabled.

vhdAccessModestring · enumOptional

VHD Access Mode values.

Possible values:

useMaxCacheSizeInMBsboolean | nullableOptional

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger · int32 | nullableOptional

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean | nullableOptional

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffstring · enumOptional

Enable State values.

Possible values:

useHealthyProvidersRequiredForRegisterboolean | nullableOptional

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean | nullableOptional

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean | nullableOptional

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger · int32 | nullableOptional

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean | nullableOptional

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterstring · enumOptional

Enable State values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3402

{
  "officeContainerEnabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "useLockedRetryCount": true,
  "lockedRetryCount": 1,
  "useLockedRetryInterval": true,
  "lockedRetryInterval": 1,
  "useAccessNetworkAsComputerObject": true,
  "accessNetworkAsComputerObject": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useAttachVHDSDDL": true,
  "attachVHDSDDL": "text",
  "useDiffDiskParentFolderPath": true,
  "diffDiskParentFolderPath": "text",
  "useFlipFlopProfileDirectoryName": true,
  "flipFlopProfileDirectoryName": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useNoProfileContainingFolder": true,
  "noProfileContainingFolder": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useOutlookCachedMode": true,
  "outlookCachedMode": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithFailure": true,
  "preventLoginWithFailure": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithTempProfile": true,
  "preventLoginWithTempProfile": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useReAttachRetryCount": true,
  "reAttachRetryCount": 1,
  "useReAttachIntervalSeconds": true,
  "reAttachIntervalSeconds": 1,
  "useRemoveOrphanedOSTFilesOnLogoff": true,
  "removeOrphanedOSTFilesOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamSearch": true,
  "roamSearch": [
    "0 = Disable",
    "1 = SingleUser",
    "2 = MultiUser"
  ],
  "useSIDDirNameMatch": true,
  "sidDirNameMatch": "text",
  "useSIDDirNamePattern": true,
  "sidDirNamePattern": "text",
  "useSIDDirSDDL": true,
  "sidDirSDDL": "text",
  "useVHDNameMatch": true,
  "vhdNameMatch": "text",
  "useVHDNamePattern": true,
  "vhdNamePattern": "text",
  "useVHDXSectorSize": true,
  "vhdxSectorSize": [
    "0 = SystemDefault",
    "512 = Size_512",
    "4096 = Size_4096"
  ],
  "useVolumeWaitTimeMS": true,
  "volumeWaitTimeMS": 1,
  "useIgnoreNonAVD": true,
  "ignoreNonAVD": [
    "0 = AnySession",
    "1 = AVDSessions"
  ],
  "useRedirectType": true,
  "redirectType": [
    "1 = Legacy",
    "2 = Advanced"
  ],
  "useIncludeOfficeActivation": true,
  "includeOfficeActivation": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOneDrive": true,
  "includeOneDrive": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOneNote": true,
  "includeOneNote": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOneNoteUWP": true,
  "includeOneNoteUWP": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOutlook": true,
  "includeOutlook": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeOutlookPersonalization": true,
  "includeOutlookPersonalization": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeSharepoint": true,
  "includeSharepoint": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeSkype": true,
  "includeSkype": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useIncludeTeams": true,
  "includeTeams": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useMirrorLocalOSTToVHD": true,
  "mirrorLocalOSTToVHD": [
    "0 = DoNothing",
    "1 = Copy",
    "2 = Move"
  ],
  "useNumSessionVHDsToKeep": true,
  "numSessionVHDsToKeep": 1,
  "useOutlookFolderPath": true,
  "outlookFolderPath": "text",
  "useRefreshUserPolicy": true,
  "refreshUserPolicy": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useVHDAccessMode": true,
  "vhdAccessMode": [
    "0 = NormalDirectAccess",
    "1 = DiffDiskNetwork",
    "2 = DiffDiskLocal",
    "3 = UniqueVHDPerSession"
  ],
  "useMaxCacheSizeInMBs": true,
  "maxCacheSizeInMBs": 1,
  "useClearCacheOnLogoff": true,
  "clearCacheOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useHealthyProvidersRequiredForRegister": true,
  "healthyProvidersRequiredForRegister": 1,
  "useHealthyProvidersRequiredForUnregister": true,
  "healthyProvidersRequiredForUnregister": 1,
  "useUnregisterTimeout": true,
  "unregisterTimeout": 1,
  "useClearCacheOnForcedUnregister": true,
  "clearCacheOnForcedUnregister": [
    "0 = Disable",
    "1 = Enable"
  ]
}

No content

Update

put

Update the FSLogix General Settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix General Settings (optional).

Body

useCleanupInvalidSessionsboolean | nullableOptional

Specifies if the 'Cleanup invalid sessions' option is enabled or disabled.

cleanupInvalidSessionsstring · enumOptional

Enable State values.

Possible values:

useRoamRecycleBinboolean | nullableOptional

Specifies if the 'Roam recycle bin' option is enabled or disabled.

roamRecycleBinstring · enumOptional

Enable State values.

Possible values:

useVHDCompactDiskboolean | nullableOptional

Specifies if the 'VHD compact disk' option is enabled or disabled.

vhdCompactDiskstring · enumOptional

Enable State values.

Possible values:

useCacheDirectoryboolean | nullableOptional

Specifies if the 'Cache directory' option is enabled or disabled.

cacheDirectorystring | nullableOptional

Specifies the 'Cache directory'.

useWriteCacheDirectoryboolean | nullableOptional

Specifies if the 'Write cache directory' option is enabled or disabled.

writeCacheDirectorystring | nullableOptional

Specifies the 'Write cache directory'.

useProxyDirectoryboolean | nullableOptional

Specifies if the 'Proxy directory' option is enabled or disabled.

proxyDirectorystring | nullableOptional

Specifies the 'Proxy directory'.

useSilenceACLWarningboolean | nullableOptional

Specifies if the 'Silence ACL warning' option is enabled or disabled.

silenceACLWarningstring · enumOptional

Enable State values.

Possible values:

logEnabledstring · enumOptional

Log enabled values.

Possible values:

logLevelstring · enumOptional

FSLogix log level values.

Possible values:

logFileKeepingPeriodinteger · int32 | nullableOptional

Specifies the 'Log keeping period in days'. Default: '2'.

logDirectorystring | nullableOptional

Specifies the 'Log directory'. Default: '%ProgramData%\FSLogix\Logs'.

robocopyLogPathstring | nullableOptional

Specifies the 'Robocopy log path'.

logSpecificComponentsstring[Flag] · enumOptional

Log specific components values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/FSLogix/General HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 1081

{
  "useCleanupInvalidSessions": true,
  "cleanupInvalidSessions": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamRecycleBin": true,
  "roamRecycleBin": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useVHDCompactDisk": true,
  "vhdCompactDisk": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useCacheDirectory": true,
  "cacheDirectory": "text",
  "useWriteCacheDirectory": true,
  "writeCacheDirectory": "text",
  "useProxyDirectory": true,
  "proxyDirectory": "text",
  "useSilenceACLWarning": true,
  "silenceACLWarning": [
    "0 = Disable",
    "1 = Enable"
  ],
  "logEnabled": [
    "0 = Disable",
    "1 = Specific",
    "2 = All"
  ],
  "logLevel": [
    "0 = Debug",
    "1 = Information",
    "2 = Warning",
    "3 = Error"
  ],
  "logFileKeepingPeriod": 1,
  "logDirectory": "text",
  "robocopyLogPath": "text",
  "logSpecificComponents": [
    "1 = ProfileConfigTool",
    "2 = IEPlugin",
    "4 = RuleEditor",
    "8 = JavaRuleEditor",
    "16 = FSLogixAgentService",
    "32 = Profile",
    "64 = JavaLauncher",
    "128 = OfficeContainer",
    "256 = RuleCompilation",
    "512 = FontVisibility",
    "1024 = Network",
    "2048 = PrinterVisibility",
    "4096 = ADSComputerGroup",
    "8192 = DriverInterface",
    "16384 = WindowsSearchRoaming",
    "32768 = WindowsSearchPlugin",
    "65536 = ProcessStartMonitor"
  ]
}

No content

Add

post

Add a user to the User Exclusion List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/UserExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user from the User Exclusion List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/UserExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Add

post

Add a folder to the Folder Exclusion List of the FSLogix Profile Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

Add FSLogix Folder Exclusion

folderstring | nullableRequired

Specifies the 'Folder' path to add to the Include/Exclude Folder List.

excludeFolderCopystring[Flag] · enumOptional

Exclude Folder Copy values.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 80

{
  "folder": "text",
  "excludeFolderCopy": [
    "0 = None",
    "1 = CopyBase",
    "2 = CopyBack"
  ]
}

No content

Update

put

Modify an item in the folder exclusion list of the FSLogix Profile Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

Change folder configuration in the FSLogix folder exclusion list

folderstring | nullableRequired

Specifies the 'Folder' path to modify within Exclude Folder List.

excludeFolderCopystring[Flag] · enumRequired

Exclude Folder Copy values.

Possible values:

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 80

{
  "folder": "text",
  "excludeFolderCopy": [
    "0 = None",
    "1 = CopyBase",
    "2 = CopyBack"
  ]
}

No content

Remove

delete

Remove a folder from the Folder Exclusion List of the FSLogix Profile Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

Remove a folder from the FSLogix folder inclusion list

folderstring | nullableRequired

Specifies the 'Folder' path to remove to the Include/Exclude Folder List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/FolderExclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 17

{
  "folder": "text"
}

No content

Add

post

Add a user to the User Inclusion List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Add a user or group account to the FSLogix user inclusion/exclusion list

accountstring | nullableOptional

The name of the user/group account to add to the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to add to the FSLogix Container.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Remove

delete

Remove a user from the User Inclusion List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Remove a user from the FSLogix user inclusion list

accountstring | nullableOptional

The name of the user/group account to remove from the FSLogix Container.

sidstring | nullableOptional

The SID of the user/group account to remove from the FSLogix Container.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/UserInclusion HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 31

{
  "account": "text",
  "sid": "text"
}

No content

Update

put

Update the FSLogix Profile Container settings of a Site Defaults object.

Query parameters

siteIdinteger · int32Optional

The SiteId of a Site Defaults object for which to modify the FSLogix Profile Container settings (optional).

Body

Update FSLogix profile configuration of a Sessions Host

profileContainerEnabledboolean | nullableOptional

Specifies if the Profile Container is enabled or disabled..

locationTypestring · enumOptional

Location Type values.

Possible values:

vhdLocationsstring[] | nullableOptional

Specifies the 'VHD Locations'.

ccdLocationsstring[] | nullableOptional

Specifies the 'CDD Locations'.

profileDiskFormatstring · enumOptional

Profile Disk Format values.

Possible values:

allocationTypestring · enumOptional

Allocation Type values.

Possible values:

defaultSizeinteger · int32 | nullableOptional

Specifies the 'Default size'.

customizeProfileFoldersboolean | nullableOptional

Enable or disable the 'Customize Profile Folders' option.

excludeCommonFoldersstring[Flag] · enumOptional

Exclude Common Folders.

Possible values:

useLockedRetryCountboolean | nullableOptional

Specifies if the 'Number of locked VHD(X) retries' option is enabled or disabled.

lockedRetryCountinteger · int32 | nullableOptional

Specifies the 'Number of locked VHD(X) retries'.

useLockedRetryIntervalboolean | nullableOptional

Specifies if the 'Delay between locked VHD(X) retries' option is enabled or disabled.

lockedRetryIntervalinteger · int32 | nullableOptional

Specifies the 'Delay between locked VHD(X) retries'.

useAccessNetworkAsComputerObjectboolean | nullableOptional

Specifies if the 'Access network as computer object' option is enabled or disabled.

accessNetworkAsComputerObjectstring · enumOptional

Enable State values.

Possible values:

useAttachVHDSDDLboolean | nullableOptional

Specifies if the 'SDDL used when attaching the VHD' option is enabled or disabled.

attachVHDSDDLstring | nullableOptional

Specifies the 'SDDL used when attaching the VHD'.

useDiffDiskParentFolderPathboolean | nullableOptional

Specifies if the 'Diff disk parent folder path' option is enabled or disabled.

diffDiskParentFolderPathstring | nullableOptional

Specifies the 'Diff disk parent folder path'.

useFlipFlopProfileDirectoryNameboolean | nullableOptional

Specifies if the 'Swap SID and username in profile directory names' option is enabled or disabled.

flipFlopProfileDirectoryNamestring · enumOptional

Enable State values.

Possible values:

useNoProfileContainingFolderboolean | nullableOptional

Specifies if the 'Do not create a folder for new profiles' option is enabled or disabled.

noProfileContainingFolderstring · enumOptional

Enable State values.

Possible values:

useOutlookCachedModeboolean | nullableOptional

Specifies if the 'Enable Cached mode for Outlook' option is enabled or disabled.

outlookCachedModestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithFailureboolean | nullableOptional

Specifies if the 'Prevent logons with failures' option is enabled or disabled.

preventLoginWithFailurestring · enumOptional

Enable State values.

Possible values:

usePreventLoginWithTempProfileboolean | nullableOptional

Specifies if the 'Prevent logons with temp profiles' option is enabled or disabled.

preventLoginWithTempProfilestring · enumOptional

Enable State values.

Possible values:

useReAttachRetryCountboolean | nullableOptional

Specifies if the 'Re-attach retry limit' option is enabled or disabled.

reAttachRetryCountinteger · int32 | nullableOptional

Specifies the 'Re-attach retry limit'.

useReAttachIntervalSecondsboolean | nullableOptional

Specifies if the 'Re-attach interval' option is enabled or disabled.

reAttachIntervalSecondsinteger · int32 | nullableOptional

Specifies the 'Re-attach interval'.

useRemoveOrphanedOSTFilesOnLogoffboolean | nullableOptional

Specifies if the 'Remove duplicate OST files on logoff' option is enabled or disabled.

removeOrphanedOSTFilesOnLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamSearchboolean | nullableOptional

Specifies if the 'Search roaming feature mode' option is enabled or disabled.

roamSearchstring · enumOptional

Roam search values.

Possible values:

useSIDDirNameMatchboolean | nullableOptional

Specifies if the 'User-to-Profile matching pattern' option is enabled or disabled.

sidDirNameMatchstring | nullableOptional

Specifies the 'User-to-Profile matching pattern'.

useSIDDirNamePatternboolean | nullableOptional

Specifies if the 'Profile folder naming pattern' option is enabled or disabled.

sidDirNamePatternstring | nullableOptional

Specifies the 'Profile folder naming pattern'.

useSIDDirSDDLboolean | nullableOptional

Specifies if the 'Use SSDL on creation of SID container folder' option is enabled or disabled.

sidDirSDDLstring | nullableOptional

Specifies the 'Use SSDL on creation of SID container folder'.

useVHDNameMatchboolean | nullableOptional

Specifies if the 'Profile VHD(X) file matching pattern' option is enabled or disabled.

vhdNameMatchstring | nullableOptional

Specifies the 'Profile VHD(X) file matching pattern'.

useVHDNamePatternboolean | nullableOptional

Specifies if the 'Naming pattern for new VHD(X) files' option is enabled or disabled.

vhdNamePatternstring | nullableOptional

Specifies the 'Naming pattern for new VHD(X) files'.

useVHDXSectorSizeboolean | nullableOptional

Specifies if the 'VHDX sector size' option is enabled or disabled.

vhdxSectorSizestring · enumOptional

Enable State values.

Possible values:

useVolumeWaitTimeMSboolean | nullableOptional

Specifies if the 'Volume wait time' option is enabled or disabled.

volumeWaitTimeMSinteger · int32 | nullableOptional

Specifies the 'Volume wait time'.

useIgnoreNonAVDboolean | nullableOptional

Specifies if the 'Ignore non-AVD sessions' option is enabled or disabled (Experimental).

ignoreNonAVDstring · enumOptional

Ignore non-AVD values.

Possible values:

useRedirectTypeboolean | nullableOptional

Specifies if the 'Redirect type' option is enabled or disabled.

redirectTypestring · enumOptional

Redirect type values.

Possible values:

useKeepLocalDirboolean | nullableOptional

Specifies if the 'Keep local profiles' option is enabled or disabled.

keepLocalDirstring · enumOptional

Enable State values.

Possible values:

useDeleteLocalProfileWhenVHDShouldApplyboolean | nullableOptional

Specifies if the 'Delete local profile when loading from VHD' option is enabled or disabled.

deleteLocalProfileWhenVHDShouldApplystring · enumOptional

Enable State values.

Possible values:

useProfileDirSDDLboolean | nullableOptional

Specifies if the 'Custom SDDL for profile directory' option is enabled or disabled.

profileDirSDDLstring | nullableOptional

Specifies the 'Custom SDDL for profile directory'.

useProfileTypeboolean | nullableOptional

Specifies if the 'Profile type' option is enabled or disabled.

profileTypestring · enumOptional

Profile Type values.

Possible values:

useSetTempToLocalPathboolean | nullableOptional

Specifies if the 'Temporary folders redirection mode' option is enabled or disabled.

setTempToLocalPathstring · enumOptional

Temporary Folder Redirection Mode values.

Possible values:

useCleanOutNotificationsboolean | nullableOptional

Specifies if the 'Clean out notifications' option is enabled or disabled.

cleanOutNotificationsstring · enumOptional

Enable State values.

Possible values:

useInstallAppxPackagesboolean | nullableOptional

Specifies if the Install Appx packages' option is enabled or disabled.

installAppxPackagesstring · enumOptional

Enable State values.

Possible values:

useRebootOnUserLogoffboolean | nullableOptional

Specifies if the 'Reboot computer when user logs off' option is enabled or disabled.

rebootOnUserLogoffstring · enumOptional

Enable State values.

Possible values:

useRoamIdentityboolean | nullableOptional

Specifies if the 'Roam identity' option is enabled or disabled.

roamIdentitystring · enumOptional

Enable State values.

Possible values:

useShutdownOnUserLogoffboolean | nullableOptional

Specifies if the 'Shutdown computer when user logs off' option is enabled or disabled.

shutdownOnUserLogoffstring · enumOptional

Enable State values.

Possible values:

useMaxCacheSizeInMBsboolean | nullableOptional

Specifies if the 'Max cache size in MBs' option is enabled or disabled.

maxCacheSizeInMBsinteger · int32 | nullableOptional

Specifies the 'Max cache size in MBs'.

useClearCacheOnLogoffboolean | nullableOptional

Specifies if the 'Clear cache on logoff' option is enabled or disabled.

clearCacheOnLogoffstring · enumOptional

Enable State values.

Possible values:

useHealthyProvidersRequiredForRegisterboolean | nullableOptional

Specifies if the 'Healthy providers required for register' option is enabled or disabled.

healthyProvidersRequiredForRegisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for register'.

useHealthyProvidersRequiredForUnregisterboolean | nullableOptional

Specifies if the 'Healthy providers required for unregister' option is enabled or disabled.

healthyProvidersRequiredForUnregisterinteger · int32 | nullableOptional

Specifies the 'Healthy providers required for unregister'.

useUnregisterTimeoutboolean | nullableOptional

Specifies if the 'Unregister timeout' option is enabled or disabled.

unregisterTimeoutinteger · int32 | nullableOptional

Specifies the 'Unregister timeout'.

useClearCacheOnForcedUnregisterboolean | nullableOptional

Specifies if the 'Clear cache on forced unregister' option is enabled or disabled.

clearCacheOnForcedUnregisterstring · enumOptional

Enable State values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

PUT /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 3397

{
  "profileContainerEnabled": true,
  "locationType": [
    "0 = SMBLocation",
    "1 = CloudCache"
  ],
  "vhdLocations": [
    "text"
  ],
  "ccdLocations": [
    "text"
  ],
  "profileDiskFormat": [
    "0 = VHD",
    "1 = VHDX"
  ],
  "allocationType": [
    "0 = Dynamic",
    "1 = Full"
  ],
  "defaultSize": 1,
  "customizeProfileFolders": true,
  "excludeCommonFolders": [
    "1 = Contacts",
    "2 = Desktop",
    "4 = Documents",
    "8 = Links",
    "16 = MusicPodcasts",
    "32 = PicturesVideos",
    "64 = FoldersLowIntegProcesses",
    "128 = Downloads"
  ],
  "useLockedRetryCount": true,
  "lockedRetryCount": 1,
  "useLockedRetryInterval": true,
  "lockedRetryInterval": 1,
  "useAccessNetworkAsComputerObject": true,
  "accessNetworkAsComputerObject": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useAttachVHDSDDL": true,
  "attachVHDSDDL": "text",
  "useDiffDiskParentFolderPath": true,
  "diffDiskParentFolderPath": "text",
  "useFlipFlopProfileDirectoryName": true,
  "flipFlopProfileDirectoryName": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useNoProfileContainingFolder": true,
  "noProfileContainingFolder": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useOutlookCachedMode": true,
  "outlookCachedMode": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithFailure": true,
  "preventLoginWithFailure": [
    "0 = Disable",
    "1 = Enable"
  ],
  "usePreventLoginWithTempProfile": true,
  "preventLoginWithTempProfile": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useReAttachRetryCount": true,
  "reAttachRetryCount": 1,
  "useReAttachIntervalSeconds": true,
  "reAttachIntervalSeconds": 1,
  "useRemoveOrphanedOSTFilesOnLogoff": true,
  "removeOrphanedOSTFilesOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamSearch": true,
  "roamSearch": [
    "0 = Disable",
    "1 = SingleUser",
    "2 = MultiUser"
  ],
  "useSIDDirNameMatch": true,
  "sidDirNameMatch": "text",
  "useSIDDirNamePattern": true,
  "sidDirNamePattern": "text",
  "useSIDDirSDDL": true,
  "sidDirSDDL": "text",
  "useVHDNameMatch": true,
  "vhdNameMatch": "text",
  "useVHDNamePattern": true,
  "vhdNamePattern": "text",
  "useVHDXSectorSize": true,
  "vhdxSectorSize": [
    "0 = SystemDefault",
    "512 = Size_512",
    "4096 = Size_4096"
  ],
  "useVolumeWaitTimeMS": true,
  "volumeWaitTimeMS": 1,
  "useIgnoreNonAVD": true,
  "ignoreNonAVD": [
    "0 = AnySession",
    "1 = AVDSessions"
  ],
  "useRedirectType": true,
  "redirectType": [
    "1 = Legacy",
    "2 = Advanced"
  ],
  "useKeepLocalDir": true,
  "keepLocalDir": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useDeleteLocalProfileWhenVHDShouldApply": true,
  "deleteLocalProfileWhenVHDShouldApply": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useProfileDirSDDL": true,
  "profileDirSDDL": "text",
  "useProfileType": true,
  "profileType": [
    "0 = NormalProfile",
    "1 = OnlyRWProfile",
    "2 = OnlyROProfile",
    "3 = RWROProfile"
  ],
  "useSetTempToLocalPath": true,
  "setTempToLocalPath": [
    "0 = TakeNoAction",
    "1 = RedirectTempAndTmp",
    "2 = RedirectINetCache",
    "3 = RedirectTempTmpAndINetCache"
  ],
  "useCleanOutNotifications": true,
  "cleanOutNotifications": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useInstallAppxPackages": true,
  "installAppxPackages": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRebootOnUserLogoff": true,
  "rebootOnUserLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useRoamIdentity": true,
  "roamIdentity": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useShutdownOnUserLogoff": true,
  "shutdownOnUserLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useMaxCacheSizeInMBs": true,
  "maxCacheSizeInMBs": 1,
  "useClearCacheOnLogoff": true,
  "clearCacheOnLogoff": [
    "0 = Disable",
    "1 = Enable"
  ],
  "useHealthyProvidersRequiredForRegister": true,
  "healthyProvidersRequiredForRegister": 1,
  "useHealthyProvidersRequiredForUnregister": true,
  "healthyProvidersRequiredForUnregister": 1,
  "useUnregisterTimeout": true,
  "unregisterTimeout": 1,
  "useClearCacheOnForcedUnregister": true,
  "clearCacheOnForcedUnregister": [
    "0 = Disable",
    "1 = Enable"
  ]
}

No content

Add

post

Add a CCDLocation to the CCDLocation List of the FSLogix Profile Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

Add a new CCDLocation to the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to add to the CCDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Delete

delete

Remove a CCDLocation from the CCDLocation List of the FSLogix Profile Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Profile Container settings (optional).

Body

Remove a CCDLocation from the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to remove from the CCDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/FSLogix/ProfileContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Add

post

Adds a CCDLocation to the CCDLocation List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Add a new CCDLocation to the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to add to the CCDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Remove

delete

Remove a CCDLocation from the CCDLocation List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Remove a CCDLocation from the FSLogix CCDLocation list

ccdLocationstring | nullableRequired

Specifies the 'CCDLocation' path to remove from the CCDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/CCDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "ccdLocation": "text"
}

No content

Add

post

Adds a VHDLocation to the VHDLocation List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Add a new VHDLocation to the FSLogix VHDLocation list

vhdLocationstring | nullableRequired

Specifies the 'VHDLocation' path to add to the VHDLocation List.

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/VHDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "vhdLocation": "text"
}

No content

Remove

delete

Remove a VHDLocation from the VHDLocation List of the FSLogix Office Container settings.

Query parameters

siteIdinteger · int32Optional

The Site ID of an object for which to modify the FSLogix Office Container settings (optional).

Body

Remove a VHDLocation from the FSLogix VHDLocation list

vhdLocationstring | nullableRequired

Specifies the 'VHDLocation' path to remove from the VHDLocation List.

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/DefaultSettings/MultiSession/FSLogix/OfficeContainer/VHDLocations HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "vhdLocation": "text"
}

No content

List

get

Retrieve Windows Service Custom

Path parameters

idinteger · int32Required

The ID of the optimization setting to retrieve the windows service custom list.

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

GET /api/AVD/Template/{id}/Optimization/WindowsService HTTP/1.1
Host: 
Accept: */*

[
  {
    "type": [
      "0 = Predefined",
      "1 = Custom"
    ],
    "serviceName": "text",
    "displayName": "text",
    "aliases": "text"
  }
]

Add

post

Adds a Windows Service Custom to optimization.

Path parameters

idinteger · int32Required

The ID of the Optimization settings to add the windows services custom.

Body

aliasesstring | nullableOptional

Windows Services Alias

displayNamestring | nullableOptional

Windows Services Diplay Name

serviceNamestring | nullableOptional

Windows Service Name

Responses

201

Created

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

409

Conflict

application/json; api-version=1.0

post

POST /api/AVD/Template/{id}/Optimization/WindowsService HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 60

{
  "aliases": "text",
  "displayName": "text",
  "serviceName": "text"
}

No content

Delete

delete

Removes Windows Service Custom From Optimization.

Path parameters

idinteger · int32Required

The ID of the optimization setting to remove the windows Service custom.

Body

serviceNamestring | nullableOptional

Windows Service Name

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

delete

DELETE /api/AVD/Template/{id}/Optimization/WindowsService HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 22

{
  "serviceName": "text"
}

No content