Template
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-07-01T23:24:42.362Z",
"timeLastMod": "2025-07-01T23:24:42.362Z",
"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
}
]
}
}
]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 · enumOptionalPossible values:
Host Session Type
cloneMethodstring · enumOptionalPossible values:
Clone Method
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 · enumOptionalPossible values:
Volume type
sizeinteger · int32Optional
Size (GiB).
maximumIOPSinteger · int64 | nullableOptional
Maximum IOPS.
throughputinteger · int64 | nullableOptional
Throughput (MB/s).
resourceGroupstring | nullableOptional
Resource group.
vmSizestring | nullableOptional
VM size.
osDiskTypestring · enumOptionalPossible values:
Volume type
virtualNetworkIDstring | nullableOptional
Virtual network ID.
virtualNetworkNamestring | nullableOptional
Virtual network name.
subnetIDstring | nullableOptional
Subnet ID.
subnetNamestring | nullableOptional
Subnet name.
imagePrepToolstring · enumOptionalPossible values:
Image preparation tool
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-07-01T23:24:42.362Z",
"timeLastMod": "2025-07-01T23:24:42.362Z",
"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
}
]
}
}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-07-01T23:24:42.362Z",
"timeLastMod": "2025-07-01T23:24:42.362Z",
"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
}
]
}
}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 · enumOptionalPossible values:
Volume type
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 · enumOptionalPossible values:
Volume type
virtualNetworkIDstring | nullableOptional
Virtual network ID.
virtualNetworkNamestring | nullableOptional
Virtual network name.
subnetIDstring | nullableOptional
Subnet ID.
subnetNamestring | nullableOptional
Subnet name.
imagePrepToolstring · enumOptionalPossible values:
Image preparation tool
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
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-07-01T23:24:42.362Z",
"timeLastMod": "2025-07-01T23:24:42.362Z",
"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
}
]
}
}Was this helpful?