Template

List

Retrieve settings about RAS Templates.

GET/api/VDI/Template

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

objTypeTemplateObjType (enum)

Template Object Type

89 = AVDTemplate,101 = RDSTemplate,102 = VDITemplate

namenullable string

Template Name

siteIdinteger (int32)

Site ID

descriptionnullable string

Template Description

providerIdinteger (int32)

Provider ID

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

vmIdnullable string

The ID of the source VM.

cloneMethodCloneMethod (enum)

Clone Method

0 = FullClone,1 = LinkedClone

advancedTemplateAdvanced (object)

RAS Template Advanced settings

preparationTemplatePreparation (object)

RAS Template Preparation settings

inheritDefaultOptimizationSettingsnullable boolean

Specifies the 'Image Optimization' object.

optimizationImageOptimization (object)

Image Optimization

licenseKeysTemplateLicense (object)

RAS Template License Keys Available to VDI/RDS Templates

Request

JavaScriptCurlPython

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

Response

200401404

[
  {
    "id": 0,
    "adminCreate": "text",
    "adminLastMod": "text",
    "timeCreate": "2024-12-21T14:29:11.671Z",
    "timeLastMod": "2024-12-21T14:29:11.671Z",
    "objType": [
      "89 = AVDTemplate",
      "101 = RDSTemplate",
      "102 = VDITemplate"
    ],
    "name": "text",
    "siteId": 0,
    "description": "text",
    "providerId": 0,
    "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": false
      },
      "physicalHost": {
        "physicalHostId": "text",
        "physicalHostName": "text"
      },
      "multipleNIC": {
        "useSeperateNetworkInterface": false,
        "address": "text",
        "subnetMask": "text"
      },
      "aws": {
        "instanceType": "text",
        "storageDevices": [
          {
            "deviceName": "text",
            "volumeType": [
              "0 = gp2",
              "1 = gp3",
              "2 = io1",
              "3 = io2",
              "4 = standard"
            ],
            "size": 0,
            "maximumIOPS": 0,
            "throughput": 0
          }
        ]
      },
      "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": false,
    "optimization": {
      "enableOptimization": false,
      "optimizationType": [
        "0 = Automatic",
        "1 = Manual"
      ],
      "windowsDefenderATP": {
        "winDefATPTurnOffOn": [
          "0 = TurnOffWindowsDefenderATP",
          "1 = TurnOnWindowsDefenderATP"
        ],
        "disableRealTimeProtection": false,
        "excludeFolders": [
          "text"
        ],
        "excludeProcesses": [
          "text"
        ],
        "excludeExtension": [
          "text"
        ]
      },
      "windowsComponents": {
        "windowsComponentsList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "componentName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsDefenderATPEnabled": false,
      "windowsComponentsEnabled": false,
      "windowsServicesEnabled": false,
      "windowsScheduledTasksEnabled": false,
      "windowsAdvancedOptionsEnabled": false,
      "networkPerformanceEnabled": false,
      "registryEnabled": false,
      "visualEffectsEnabled": false,
      "diskCleanupEnabled": false,
      "customScriptEnabled": false,
      "windowsServices": {
        "windowsServicesList": [
          {
            "type": [
              "0 = Predefined",
              "1 = Custom"
            ],
            "serviceName": "text",
            "displayName": "text",
            "aliases": "text"
          }
        ]
      },
      "windowsAdvancedOptions": {
        "partialStartLayoutContent": "text",
        "hibernate": false,
        "teleCollection": false,
        "systemRestore": false,
        "additionalErrorReport": false,
        "tiles": false,
        "cortana": false,
        "microsoftConsumerExperience": false,
        "windowsTips": false,
        "commonProgramGroups": false,
        "partialStartMenu": false
      },
      "networkPerformance": {
        "dirCacheMax": 0,
        "dormantFileLimit": 0,
        "fileNotFoundCache": 0,
        "fileInfoCache": 0,
        "fileInfoCacheEnable": false,
        "directoryCacheEnable": false,
        "fileNotFoundCacheEnable": false,
        "dormantFileLimitEnable": false,
        "disableTCP": false,
        "disableIPv6CompEnable": false,
        "disableIPv6ToIPv4": false,
        "disableIsaTap": false
      },
      "customScript": {
        "arguments": "text",
        "command": "text",
        "initDir": "text",
        "user": "text"
      },
      "diskCleanup": {
        "cleanupWinSxSFolder": false,
        "cleanupSystemFiles": false,
        "cleanupTemporaryFileLogs": false,
        "removeOneDrive": false,
        "deleteUserProfiles": false
      },
      "visualEffects": {
        "visualEffectsTypes": [
          "0 = LetWindowsChooseWhatsBest",
          "1 = AdjustForBestAppearance",
          "2 = AdjustForBestPerformance",
          "3 = Custom"
        ],
        "animateControlSelectElements": false,
        "animateWindowsWhenMinimizingMaximizing": false,
        "animateTaskbar": false,
        "enablePeek": false,
        "fadeSlideMenus": false,
        "fadeSlideToolTips": false,
        "fadeOutMenuItems": false,
        "saveTaskbarThumbnail": false,
        "showShadowUnderMouse": false,
        "shadowUnderWindows": false,
        "thumbnailsInsteadOfIcons": false,
        "showTranslucentSelection": false,
        "showWindowsContentWhilstDragging": false,
        "slideOpenComboBoxes": false,
        "smoothEdgesScreenFonts": false,
        "smoothScrollListBoxes": false,
        "dropShadowsIcon": false
      },
      "windowsScheduledTasks": {
        "windowsScheduledTasksList": [
          {
            "task": "text",
            "location": "text",
            "type": [
              "0 = Folder",
              "1 = Task"
            ]
          }
        ]
      },
      "registry": {
        "registryList": [
          {
            "id": 0,
            "action": [
              "0 = Add",
              "1 = Modify",
              "2 = Delete"
            ],
            "registryName": "text",
            "dwordValue": 0,
            "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": 0
        }
      ]
    }
  }
]

Create

Creates a new RAS Template.

POST/api/VDI/Template

Body

application/json; api-version=1.0

Template settings

providerId*integer (int32)

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

vmId*nullable string

The ID of the source VM.

namenullable string

RAS Template Name.

siteIdinteger (int32)

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.

descriptionnullable string

RAS Template Description.

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

cloneMethodCloneMethod (enum)

Clone Method

0 = FullClone,1 = LinkedClone

folderNamenullable string

Folder name where desktop VMs will be created.

folderIdnullable string

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

subFolderNamenullable string

Subfolder name where desktop VMs will be created.

nativePoolIdnullable string

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

nativePoolNamenullable string

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

hwgpuboolean

Enable hardware acceleration graphics licensing support.

physicalHostIdnullable string

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

physicalHostNamenullable string

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

useSeperateNetworkInterfaceboolean

Use a separate network interface for LAN access.

addressnullable string

The address of the network interface.

subnetMasknullable string

The subnet mask of the network interface.

instanceTypenullable string

Instance type.

deviceNamenullable string

Device name.

volumeTypeVolumeType (enum)

Volume type

0 = gp2,1 = gp3,2 = io1,3 = io2,4 = standard

sizeinteger (int32)

Size (GiB).

maximumIOPSnullable integer (int64)

Maximum IOPS.

throughputnullable integer (int64)

Throughput (MB/s).

resourceGroupnullable string

Resource group.

vmSizenullable string

VM size.

osDiskTypeDiskType (enum)

Volume type

1 = StandardHDD,2 = StandardSSD,4 = PremiumSSD

virtualNetworkIDnullable string

Virtual network ID.

virtualNetworkNamenullable string

Virtual network name.

subnetIDnullable string

Subnet ID.

subnetNamenullable string

Subnet name.

imagePrepToolImagePrepTool (enum)

Image preparation tool

0 = SysPrep,1 = RASPrep

computerNamenullable string

The FQDN or IP address of the target VM.

ownerNamenullable string

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

organizationnullable string

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

domain*nullable string

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

domainPassword*nullable string

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

administrator*nullable string

The administrator of the domain specified in the JoinDomain parameter.

adminPassword*nullable string

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

domainOrgUnitnullable string

Domain Organization unit

Response

201401409

Created

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

objTypeTemplateObjType (enum)

Template Object Type

89 = AVDTemplate,101 = RDSTemplate,102 = VDITemplate

namenullable string

Template Name

siteIdinteger (int32)

Site ID

descriptionnullable string

Template Description

providerIdinteger (int32)

Provider ID

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

vmIdnullable string

The ID of the source VM.

cloneMethodCloneMethod (enum)

Clone Method

0 = FullClone,1 = LinkedClone

advancedTemplateAdvanced (object)

RAS Template Advanced settings

preparationTemplatePreparation (object)

RAS Template Preparation settings

inheritDefaultOptimizationSettingsnullable boolean

Specifies the 'Image Optimization' object.

optimizationImageOptimization (object)

Image Optimization

licenseKeysTemplateLicense (object)

RAS Template License Keys Available to VDI/RDS Templates

Request

JavaScriptCurlPython

const response = await fetch('/api/VDI/Template', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({
      "administrator": "text",
      "adminPassword": "text",
      "domain": "text",
      "domainPassword": "text",
      "providerId": 0,
      "vmId": "text"
    }),
});
const data = await response.json();

Response

201401409

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:29:11.671Z",
  "timeLastMod": "2024-12-21T14:29:11.671Z",
  "objType": [
    "89 = AVDTemplate",
    "101 = RDSTemplate",
    "102 = VDITemplate"
  ],
  "name": "text",
  "siteId": 0,
  "description": "text",
  "providerId": 0,
  "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": false
    },
    "physicalHost": {
      "physicalHostId": "text",
      "physicalHostName": "text"
    },
    "multipleNIC": {
      "useSeperateNetworkInterface": false,
      "address": "text",
      "subnetMask": "text"
    },
    "aws": {
      "instanceType": "text",
      "storageDevices": [
        {
          "deviceName": "text",
          "volumeType": [
            "0 = gp2",
            "1 = gp3",
            "2 = io1",
            "3 = io2",
            "4 = standard"
          ],
          "size": 0,
          "maximumIOPS": 0,
          "throughput": 0
        }
      ]
    },
    "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": false,
  "optimization": {
    "enableOptimization": false,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": false,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": false,
    "windowsComponentsEnabled": false,
    "windowsServicesEnabled": false,
    "windowsScheduledTasksEnabled": false,
    "windowsAdvancedOptionsEnabled": false,
    "networkPerformanceEnabled": false,
    "registryEnabled": false,
    "visualEffectsEnabled": false,
    "diskCleanupEnabled": false,
    "customScriptEnabled": false,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": false,
      "teleCollection": false,
      "systemRestore": false,
      "additionalErrorReport": false,
      "tiles": false,
      "cortana": false,
      "microsoftConsumerExperience": false,
      "windowsTips": false,
      "commonProgramGroups": false,
      "partialStartMenu": false
    },
    "networkPerformance": {
      "dirCacheMax": 0,
      "dormantFileLimit": 0,
      "fileNotFoundCache": 0,
      "fileInfoCache": 0,
      "fileInfoCacheEnable": false,
      "directoryCacheEnable": false,
      "fileNotFoundCacheEnable": false,
      "dormantFileLimitEnable": false,
      "disableTCP": false,
      "disableIPv6CompEnable": false,
      "disableIPv6ToIPv4": false,
      "disableIsaTap": false
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": false,
      "cleanupSystemFiles": false,
      "cleanupTemporaryFileLogs": false,
      "removeOneDrive": false,
      "deleteUserProfiles": false
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": false,
      "animateWindowsWhenMinimizingMaximizing": false,
      "animateTaskbar": false,
      "enablePeek": false,
      "fadeSlideMenus": false,
      "fadeSlideToolTips": false,
      "fadeOutMenuItems": false,
      "saveTaskbarThumbnail": false,
      "showShadowUnderMouse": false,
      "shadowUnderWindows": false,
      "thumbnailsInsteadOfIcons": false,
      "showTranslucentSelection": false,
      "showWindowsContentWhilstDragging": false,
      "slideOpenComboBoxes": false,
      "smoothEdgesScreenFonts": false,
      "smoothScrollListBoxes": false,
      "dropShadowsIcon": false
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 0,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 0,
          "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": 0
      }
    ]
  }
}

Get

Retrieve settings of a RAS Template.

GET/api/VDI/Template/{id}

Path parameters

id*integer (int32)

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

Response

200401404

Success

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

objTypeTemplateObjType (enum)

Template Object Type

89 = AVDTemplate,101 = RDSTemplate,102 = VDITemplate

namenullable string

Template Name

siteIdinteger (int32)

Site ID

descriptionnullable string

Template Description

providerIdinteger (int32)

Provider ID

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

vmIdnullable string

The ID of the source VM.

cloneMethodCloneMethod (enum)

Clone Method

0 = FullClone,1 = LinkedClone

advancedTemplateAdvanced (object)

RAS Template Advanced settings

preparationTemplatePreparation (object)

RAS Template Preparation settings

inheritDefaultOptimizationSettingsnullable boolean

Specifies the 'Image Optimization' object.

optimizationImageOptimization (object)

Image Optimization

licenseKeysTemplateLicense (object)

RAS Template License Keys Available to VDI/RDS Templates

Request

JavaScriptCurlPython

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

Response

200401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:29:11.671Z",
  "timeLastMod": "2024-12-21T14:29:11.671Z",
  "objType": [
    "89 = AVDTemplate",
    "101 = RDSTemplate",
    "102 = VDITemplate"
  ],
  "name": "text",
  "siteId": 0,
  "description": "text",
  "providerId": 0,
  "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": false
    },
    "physicalHost": {
      "physicalHostId": "text",
      "physicalHostName": "text"
    },
    "multipleNIC": {
      "useSeperateNetworkInterface": false,
      "address": "text",
      "subnetMask": "text"
    },
    "aws": {
      "instanceType": "text",
      "storageDevices": [
        {
          "deviceName": "text",
          "volumeType": [
            "0 = gp2",
            "1 = gp3",
            "2 = io1",
            "3 = io2",
            "4 = standard"
          ],
          "size": 0,
          "maximumIOPS": 0,
          "throughput": 0
        }
      ]
    },
    "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": false,
  "optimization": {
    "enableOptimization": false,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": false,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": false,
    "windowsComponentsEnabled": false,
    "windowsServicesEnabled": false,
    "windowsScheduledTasksEnabled": false,
    "windowsAdvancedOptionsEnabled": false,
    "networkPerformanceEnabled": false,
    "registryEnabled": false,
    "visualEffectsEnabled": false,
    "diskCleanupEnabled": false,
    "customScriptEnabled": false,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": false,
      "teleCollection": false,
      "systemRestore": false,
      "additionalErrorReport": false,
      "tiles": false,
      "cortana": false,
      "microsoftConsumerExperience": false,
      "windowsTips": false,
      "commonProgramGroups": false,
      "partialStartMenu": false
    },
    "networkPerformance": {
      "dirCacheMax": 0,
      "dormantFileLimit": 0,
      "fileNotFoundCache": 0,
      "fileInfoCache": 0,
      "fileInfoCacheEnable": false,
      "directoryCacheEnable": false,
      "fileNotFoundCacheEnable": false,
      "dormantFileLimitEnable": false,
      "disableTCP": false,
      "disableIPv6CompEnable": false,
      "disableIPv6ToIPv4": false,
      "disableIsaTap": false
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": false,
      "cleanupSystemFiles": false,
      "cleanupTemporaryFileLogs": false,
      "removeOneDrive": false,
      "deleteUserProfiles": false
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": false,
      "animateWindowsWhenMinimizingMaximizing": false,
      "animateTaskbar": false,
      "enablePeek": false,
      "fadeSlideMenus": false,
      "fadeSlideToolTips": false,
      "fadeOutMenuItems": false,
      "saveTaskbarThumbnail": false,
      "showShadowUnderMouse": false,
      "shadowUnderWindows": false,
      "thumbnailsInsteadOfIcons": false,
      "showTranslucentSelection": false,
      "showWindowsContentWhilstDragging": false,
      "slideOpenComboBoxes": false,
      "smoothEdgesScreenFonts": false,
      "smoothScrollListBoxes": false,
      "dropShadowsIcon": false
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 0,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 0,
          "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": 0
      }
    ]
  }
}

Update

Modifies the settings of a RAS Template.

PUT/api/VDI/Template/{id}

Path parameters

id*integer (int32)

The ID of a RAS Template to modify.

Body

application/json; api-version=1.0

Template settings

descriptionnullable string

RAS Template Description.

folderNamenullable string

Folder name where desktop VMs will be created.

folderIdnullable string

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

subFolderNamenullable string

Subfolder name where desktop VMs will be created.

nativePoolIdnullable string

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

nativePoolNamenullable string

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

hwgpunullable boolean

Enable hardware acceleration graphics licensing support.

physicalHostIdnullable string

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

physicalHostNamenullable string

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

useSeperateNetworkInterfacenullable boolean

Use a separate network interface for LAN access.

addressnullable string

The address of the network interface.

subnetMasknullable string

The subnet mask of the network interface.

instanceTypenullable string

Instance type.

deviceNamenullable string

Device name.

volumeTypeVolumeType (enum)

Volume type

0 = gp2,1 = gp3,2 = io1,3 = io2,4 = standard

sizenullable integer (int64)

Size (GiB).

maximumIOPSnullable integer (int64)

Maximum IOPS.

throughputnullable integer (int64)

Throughput (MB/s).

resourceGroupnullable string

Resource group.

vmSizenullable string

VM size.

osDiskTypeDiskType (enum)

Volume type

1 = StandardHDD,2 = StandardSSD,4 = PremiumSSD

virtualNetworkIDnullable string

Virtual network ID.

virtualNetworkNamenullable string

Virtual network name.

subnetIDnullable string

Subnet ID.

subnetNamenullable string

Subnet name.

imagePrepToolImagePrepTool (enum)

Image preparation tool

0 = SysPrep,1 = RASPrep

computerNamenullable string

The FQDN or IP address of the target VM.

ownerNamenullable string

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

organizationnullable string

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

domainnullable string

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

domainPasswordnullable string

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

administratornullable string

The administrator of the domain specified in the JoinDomain parameter.

adminPasswordnullable string

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

domainOrgUnitnullable string

Domain Organization unit

inheritDefaultOptimizationSettingsnullable boolean

If true, default Optimization settings will be inherited.

Response

204401404

No Content

Request

JavaScriptCurlPython

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

Response

401404

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

Delete

Remove settings of a RAS Template.

DELETE/api/VDI/Template/{id}

Path parameters

id*integer (int32)

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

Response

204401404

No Content

Body

application/json; api-version=1.0

idinteger (int32)

ID of the object.

adminCreatenullable string

User who created the object.

adminLastModnullable string

User who last modified the object.

timeCreatestring (date-time)

Time when the object was created.

timeLastModstring (date-time)

Time when the object was last modified.

objTypeTemplateObjType (enum)

Template Object Type

89 = AVDTemplate,101 = RDSTemplate,102 = VDITemplate

namenullable string

Template Name

siteIdinteger (int32)

Site ID

descriptionnullable string

Template Description

providerIdinteger (int32)

Provider ID

templateTypeHostSessionType (enum)

Host Session Type

0 = SingleSession,1 = MultiSession

vmIdnullable string

The ID of the source VM.

cloneMethodCloneMethod (enum)

Clone Method

0 = FullClone,1 = LinkedClone

advancedTemplateAdvanced (object)

RAS Template Advanced settings

preparationTemplatePreparation (object)

RAS Template Preparation settings

inheritDefaultOptimizationSettingsnullable boolean

Specifies the 'Image Optimization' object.

optimizationImageOptimization (object)

Image Optimization

licenseKeysTemplateLicense (object)

RAS Template License Keys Available to VDI/RDS Templates

Request

JavaScriptCurlPython

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

Response

204401404

{
  "id": 0,
  "adminCreate": "text",
  "adminLastMod": "text",
  "timeCreate": "2024-12-21T14:29:11.671Z",
  "timeLastMod": "2024-12-21T14:29:11.671Z",
  "objType": [
    "89 = AVDTemplate",
    "101 = RDSTemplate",
    "102 = VDITemplate"
  ],
  "name": "text",
  "siteId": 0,
  "description": "text",
  "providerId": 0,
  "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": false
    },
    "physicalHost": {
      "physicalHostId": "text",
      "physicalHostName": "text"
    },
    "multipleNIC": {
      "useSeperateNetworkInterface": false,
      "address": "text",
      "subnetMask": "text"
    },
    "aws": {
      "instanceType": "text",
      "storageDevices": [
        {
          "deviceName": "text",
          "volumeType": [
            "0 = gp2",
            "1 = gp3",
            "2 = io1",
            "3 = io2",
            "4 = standard"
          ],
          "size": 0,
          "maximumIOPS": 0,
          "throughput": 0
        }
      ]
    },
    "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": false,
  "optimization": {
    "enableOptimization": false,
    "optimizationType": [
      "0 = Automatic",
      "1 = Manual"
    ],
    "windowsDefenderATP": {
      "winDefATPTurnOffOn": [
        "0 = TurnOffWindowsDefenderATP",
        "1 = TurnOnWindowsDefenderATP"
      ],
      "disableRealTimeProtection": false,
      "excludeFolders": [
        "text"
      ],
      "excludeProcesses": [
        "text"
      ],
      "excludeExtension": [
        "text"
      ]
    },
    "windowsComponents": {
      "windowsComponentsList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "componentName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsDefenderATPEnabled": false,
    "windowsComponentsEnabled": false,
    "windowsServicesEnabled": false,
    "windowsScheduledTasksEnabled": false,
    "windowsAdvancedOptionsEnabled": false,
    "networkPerformanceEnabled": false,
    "registryEnabled": false,
    "visualEffectsEnabled": false,
    "diskCleanupEnabled": false,
    "customScriptEnabled": false,
    "windowsServices": {
      "windowsServicesList": [
        {
          "type": [
            "0 = Predefined",
            "1 = Custom"
          ],
          "serviceName": "text",
          "displayName": "text",
          "aliases": "text"
        }
      ]
    },
    "windowsAdvancedOptions": {
      "partialStartLayoutContent": "text",
      "hibernate": false,
      "teleCollection": false,
      "systemRestore": false,
      "additionalErrorReport": false,
      "tiles": false,
      "cortana": false,
      "microsoftConsumerExperience": false,
      "windowsTips": false,
      "commonProgramGroups": false,
      "partialStartMenu": false
    },
    "networkPerformance": {
      "dirCacheMax": 0,
      "dormantFileLimit": 0,
      "fileNotFoundCache": 0,
      "fileInfoCache": 0,
      "fileInfoCacheEnable": false,
      "directoryCacheEnable": false,
      "fileNotFoundCacheEnable": false,
      "dormantFileLimitEnable": false,
      "disableTCP": false,
      "disableIPv6CompEnable": false,
      "disableIPv6ToIPv4": false,
      "disableIsaTap": false
    },
    "customScript": {
      "arguments": "text",
      "command": "text",
      "initDir": "text",
      "user": "text"
    },
    "diskCleanup": {
      "cleanupWinSxSFolder": false,
      "cleanupSystemFiles": false,
      "cleanupTemporaryFileLogs": false,
      "removeOneDrive": false,
      "deleteUserProfiles": false
    },
    "visualEffects": {
      "visualEffectsTypes": [
        "0 = LetWindowsChooseWhatsBest",
        "1 = AdjustForBestAppearance",
        "2 = AdjustForBestPerformance",
        "3 = Custom"
      ],
      "animateControlSelectElements": false,
      "animateWindowsWhenMinimizingMaximizing": false,
      "animateTaskbar": false,
      "enablePeek": false,
      "fadeSlideMenus": false,
      "fadeSlideToolTips": false,
      "fadeOutMenuItems": false,
      "saveTaskbarThumbnail": false,
      "showShadowUnderMouse": false,
      "shadowUnderWindows": false,
      "thumbnailsInsteadOfIcons": false,
      "showTranslucentSelection": false,
      "showWindowsContentWhilstDragging": false,
      "slideOpenComboBoxes": false,
      "smoothEdgesScreenFonts": false,
      "smoothScrollListBoxes": false,
      "dropShadowsIcon": false
    },
    "windowsScheduledTasks": {
      "windowsScheduledTasksList": [
        {
          "task": "text",
          "location": "text",
          "type": [
            "0 = Folder",
            "1 = Task"
          ]
        }
      ]
    },
    "registry": {
      "registryList": [
        {
          "id": 0,
          "action": [
            "0 = Add",
            "1 = Modify",
            "2 = Delete"
          ],
          "registryName": "text",
          "dwordValue": 0,
          "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": 0
      }
    ]
  }
}