List

Retrieve Default Windows Service Custom

get

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsService

Query parameters

siteIDinteger · int32

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsService'

200

401

404

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

Success

Add

Adds a default Windows Service Custom to optimization.

post

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsService

Query parameters

siteIDinteger · int32

The Site ID of the Optimization settings to retrieve the windows services custom.

Body

aliasesstring | nullable

<para type="synopsis">Windows Services Alias</para> <para type="description"></para>

displayNamestring | nullable

<para type="synopsis">Windows Services Diplay Name</para> <para type="description"></para>

serviceNamestring | nullable

<para type="synopsis">Windows Service Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsService' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "aliases": "text",
    "displayName": "text",
    "serviceName": "text"
  }'

201

401

404

409

No body

Created

Delete

Removes Default Windows Service Custom From Optimization.

delete

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsService

Query parameters

siteIDinteger · int32

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

Body

serviceNamestring | nullable

<para type="synopsis">Windows Service Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsService' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "serviceName": "text"
  }'

204

401

404

No body

No Content

Get

Retrieve the default image optimization settings by Site Id.

get

/api/AVD/DefaultSettings/SingleSession/Optimization

Query parameters

siteIdinteger · int32

The Site Id of the default image optimization

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization'

200

401

404

{
  "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"
    ]
  }
}

Success

Update

Update the Default Image Optimization settings with the specified Site ID.

put

/api/AVD/DefaultSettings/SingleSession/Optimization

Query parameters

siteIdinteger · int32

The Site Id for which to modify the Image Optimization.

Body

enableOptimizationboolean | nullable

<para type="synopsis">Whether Optimization is Enabled or not</para> <para type="description"></para>

optimizationTypestring · enum

<para type="synopsis">Optimization Type</para> <para type="description"></para>

Options: 0 = Automatic,1 = Manual

windowsDefenderATPEnabledboolean | nullable

<para type="synopsis">Whether Windows Defender ATP is enabled or not</para> <para type="description"></para>

windowsComponentsEnabledboolean | nullable

<para type="synopsis">Whether Windows Components is enabled or not</para> <para type="description"></para>

windowsServicesEnabledboolean | nullable

<para type="synopsis">Whether Windows Services is enabled or not</para> <para type="description"></para>

windowsScheduledTasksEnabledboolean | nullable

<para type="synopsis">Whether Windows Scheduled Task is enabled or not</para> <para type="description"></para>

windowsAdvancedOptionsEnabledboolean | nullable

<para type="synopsis">Whether Windows Advanced Options is enabled or not</para> <para type="description"></para>

networkPerformanceEnabledboolean | nullable

<para type="synopsis">Whether Network Performance is enabled or not</para> <para type="description"></para>

registryEnabledboolean | nullable

<para type="synopsis">Whether Registry is enabled or not</para> <para type="description"></para>

visualEffectsEnabledboolean | nullable

<para type="synopsis">Whether Visual Effects is enabled or not</para> <para type="description"></para>

diskCleanupEnabledboolean | nullable

<para type="synopsis">Whether Disk Cleanup is enabled or not</para> <para type="description"></para>

customScriptEnabledboolean | nullable

<para type="synopsis">Whether Custom Script is enabled or not</para> <para type="description"></para>

winDefATPTurnOffOnstring · enum

<para type="synopsis">Windows enable options</para> <para type="description"></para>

Options: 0 = TurnOffWindowsDefenderATP,1 = TurnOnWindowsDefenderATP

disableRealTimeProtectionboolean | nullable

<para type="synopsis">Disable Real Time Protection</para> <para type="description"></para>

excludeFoldersstring[] | nullable

<para type="synopsis">Exclude Folders List</para> <para type="description"></para>

excludeProcessesstring[] | nullable

<para type="synopsis">Exclude Processes</para> <para type="description"></para>

excludeExtensionstring[] | nullable

<para type="synopsis">Exclude Extensions</para> <para type="description"></para>

partialStartLayoutContentstring | nullable

<para type="synopsis">Partial Start menu layout</para> <para type="description"></para>

hibernateboolean | nullable

<para type="synopsis">Whether Hibernate is enabled or not</para> <para type="description"></para>

teleCollectionboolean | nullable

<para type="synopsis">Whether TeleCollection is enabled or not</para> <para type="description"></para>

systemRestoreboolean | nullable

<para type="synopsis">Whether System Restore is enabled or not</para> <para type="description"></para>

additionalErrorReportboolean | nullable

<para type="synopsis">Whether Additional Error Reporting is enabled or not</para> <para type="description"></para>

tilesboolean | nullable

<para type="synopsis">Whether Tiles is enabled or not</para> <para type="description"></para>

cortanaboolean | nullable

<para type="synopsis">Whether Cortana is enabled or not</para> <para type="description"></para>

microsoftConsumerExperienceboolean | nullable

<para type="synopsis">Whether Microsoft Consumer Experience is enabled or not</para> <para type="description"></para>

windowsTipsboolean | nullable

<para type="synopsis">Whether Windows Tips is enabled or not</para> <para type="description"></para>

commonProgramGroupsboolean | nullable

<para type="synopsis">Whether Common Program Groups is enabled or not</para> <para type="description"></para>

partialStartMenuboolean | nullable

<para type="synopsis">Whether Partial Start Menu is enabled or not</para> <para type="description"></para>

dirCacheMaxinteger · int32 | nullable

<para type="synopsis">Directory Cache Value</para> <para type="description"></para>

dormantFileLimitinteger · int32 | nullable

<para type="synopsis">Dormant File Limit Value</para> <para type="description"></para>

fileNotFoundCacheinteger · int32 | nullable

<para type="synopsis">File Not Found Cache Value</para> <para type="description"></para>

fileInfoCacheinteger · int32 | nullable

<para type="synopsis">File Info Cache Value</para> <para type="description"></para>

fileInfoCacheEnableboolean | nullable

<para type="synopsis">Whether File Info Cache is enabled or not</para> <para type="description"></para>

directoryCacheEnableboolean | nullable

<para type="synopsis">Whether Directory Cache is enabled or not</para> <para type="description"></para>

fileNotFoundCacheEnableboolean | nullable

<para type="synopsis">Whether File Not Found Cache is enabled or not</para> <para type="description"></para>

dormantFileLimitEnableboolean | nullable

<para type="synopsis">Whether Dormant File Limit is enabled or not</para> <para type="description"></para>

disableTCPboolean | nullable

<para type="synopsis">Whether Disable TCP is enabled or not</para> <para type="description"></para>

disableIPv6CompEnableboolean | nullable

<para type="synopsis">Whether Disable IPv6 Components is enabled or not</para> <para type="description"></para>

disableIPv6ToIPv4boolean | nullable

<para type="synopsis">Whether Disable IPv6 To IPv4 is enabled or not</para> <para type="description"></para>

disableIsaTapboolean | nullable

<para type="synopsis">Whether Disable IsaTap for IPv6 is enabled or not</para> <para type="description"></para>

argumentsstring | nullable

<para type="synopsis">Arguments</para> <para type="description"></para>

commandstring | nullable

<para type="synopsis">Command</para> <para type="description"></para>

initDirstring | nullable

<para type="synopsis">Initial Directory</para> <para type="description"></para>

userstring | nullable

passwordstring | nullable

<para type="synopsis">Password</para> <para type="description"></para>

cleanupWinSxSFolderboolean | nullable

<para type="synopsis">Whether Clean up windows SxS Folder is enabled or not</para> <para type="description"></para>

cleanupSystemFilesboolean | nullable

<para type="synopsis">Whether Clean up system files is enabled or not</para> <para type="description"></para>

cleanupTemporaryFileLogsboolean | nullable

<para type="synopsis">Whether Clean up temporary file logs is enabled or not</para> <para type="description"></para>

removeOneDriveboolean | nullable

<para type="synopsis">Whether Remove One Drives is enabled or not</para> <para type="description"></para>

deleteUserProfilesboolean | nullable

<para type="synopsis">Whether Delete User Profiles is enabled or not</para> <para type="description"></para>

visualEffectsTypesstring · enum

<para type="synopsis">Visual Effects Type</para> <para type="description"></para>

Options: 0 = LetWindowsChooseWhatsBest,1 = AdjustForBestAppearance,2 = AdjustForBestPerformance,3 = Custom

animateControlSelectElementsboolean | nullable

<para type="synopsis">Whether Animate Control Select Elements is enabled or not</para> <para type="description"></para>

animateWindowsWhenMinimizingMaximizingboolean | nullable

<para type="synopsis">Whether Animate Windows When Minimizing Or Maximizing is enabled or not</para> <para type="description"></para>

animateTaskbarboolean | nullable

<para type="synopsis">Whether Animate Taskbar is enabled or not</para> <para type="description"></para>

enablePeekboolean | nullable

<para type="synopsis">Whether Peek is enabled or not</para> <para type="description"></para>

fadeSlideMenusboolean | nullable

<para type="synopsis">Whether Fade Slide Menus is enabled or not</para> <para type="description"></para>

fadeSlideToolTipsboolean | nullable

<para type="synopsis">Whether Fade Slide Tool Tips is enabled or not</para> <para type="description"></para>

fadeOutMenuItemsboolean | nullable

<para type="synopsis">Whether Fade Out Menu Items is enabled or not</para> <para type="description"></para>

saveTaskbarThumbnailboolean | nullable

<para type="synopsis">Whether Taskbar Thumbnail is enabled or not</para> <para type="description"></para>

showShadowUnderMouseboolean | nullable

<para type="synopsis">Whether Shadow Under Mouse is enabled or not</para> <para type="description"></para>

shadowUnderWindowsboolean | nullable

<para type="synopsis">Whether Shadow Under Windows is enabled or not</para> <para type="description"></para>

thumbnailsInsteadOfIconsboolean | nullable

<para type="synopsis">Whether Thumbnails instead of icons is enabled or not</para> <para type="description"></para>

showTranslucentSelectionboolean | nullable

<para type="synopsis">Whether Translucent Selection is enabled or not</para> <para type="description"></para>

showWindowsContentWhilstDraggingboolean | nullable

<para type="synopsis">Whether Windows Content Whilst Dragging is enabled or not</para> <para type="description"></para>

slideOpenComboBoxesboolean | nullable

<para type="synopsis">Whether Slide open combo boxes is enabled or not</para> <para type="description"></para>

smoothEdgesScreenFontsboolean | nullable

<para type="synopsis">Whether Smooth Edges Screen Fonts is enabled or not</para> <para type="description"></para>

smoothScrollListBoxesboolean | nullable

<para type="synopsis">Whether Smooth Scroll List Boxes is enabled or not</para> <para type="description"></para>

dropShadowsIconboolean | nullable

<para type="synopsis">Whether Drop Shadow Icon is enabled or not</para> <para type="description"></para>

forceboolean · default: false

<para type="description">Force Optimization.</para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "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": false
  }'

204

401

404

No body

No Content

List

Retrieve default Registry.

get

/api/AVD/DefaultSettings/SingleSession/Optimization/Registry

Query parameters

siteidinteger · int32

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/Registry'

200

401

404

[
  {
    "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"
  }
]

Success

Add

Adds Registry to the default optimization.

post

/api/AVD/DefaultSettings/SingleSession/Optimization/Registry

Query parameters

siteIdinteger · int32

The Site Id of the optimization to retrieve the registry.

Body

actionstring · enum

<para type="synopsis">The action type for add registry entry</para> <para type="description"></para>

Options: 0 = Add,1 = Modify,2 = Delete

registryNamestring | nullable

dwordValueinteger · int32

<para type="synopsis">Value</para> <para type="description"></para>

displayNamestring | nullablerequired

<para type="synopsis">Display Name</para> <para type="description"></para>

hiveTypestring · enum

<para type="synopsis">The hive type for add registry entry</para> <para type="description"></para>

Options: 0 = HKEY_CURRENT_CONFIG,1 = HKEY_USERS,2 = HKEY_LOCAL_MACHINE,3 = HKEY_CLASSES_ROOT

pathstring | nullablerequired

regTypestring · enum

<para type="synopsis">The value type for add registry entry</para> <para type="description"></para>

Options: 0 = REG_SZ,1 = REG_DWORD,2 = REG_QWORD,3 = REG_MULTI_SZ,4 = REG_EXPAND_SZ

stringValuestring | nullable

<para type="synopsis">String Value</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/Registry' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "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"
  }'

201

401

404

409

No body

Created

Delete

Remove Default Registry Image Optimization Object.

delete

/api/AVD/DefaultSettings/SingleSession/Optimization/Registry

Query parameters

siteIdinteger · int32

The Site Id of the Optimization Settings to remove the registry object.

Body

registryIdinteger · int32required

<para type="synopsis">Registry Id</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/Registry' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "registryId": 1
  }'

204

401

404

No body

No Content

Windows Scheduled Task

List

Retrieve Default Windows Custom Component

get

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsComponent

Query parameters

siteIDinteger · int32

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsComponent'

200

401

404

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

Success

Add

Adds a default Windows Component Custom to optimization.

post

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsComponent

Query parameters

siteIDinteger · int32

The site ID of the Optimization settings to retrieve the windows component custom.

Body

aliasesstring | nullable

<para type="synopsis">Windows Components Alias</para> <para type="description"></para>

displayNamestring | nullable

<para type="synopsis">Windows Components Diplay Name</para> <para type="description"></para>

componentNamestring | nullable

<para type="synopsis">Windows Components Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsComponent' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "aliases": "text",
    "displayName": "text",
    "componentName": "text"
  }'

201

401

404

409

No body

Created

Delete

Removes Default Windows Component Custom From Optimization.

delete

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsComponent

Query parameters

siteIDinteger · int32

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

Body

componentNamestring | nullable

<para type="synopsis">Windows Component Name</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsComponent' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "componentName": "text"
  }'

204

401

404

No body

No Content

List

Retrieve Default Windows Scheduled Task

get

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsScheduledTask

Query parameters

siteIdinteger · int32

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

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsScheduledTask'

200

401

404

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

Success

Add

Adds a Windows Scheduled task to default optimization.

post

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsScheduledTask

Query parameters

siteIdinteger · int32

The Site Id of the Optimization settings to retrieve the windows scheduled task.

Body

taskstring | nullablerequired

<para type="synopsis">Scheduled Task Name</para> <para type="description"></para>

locationstring | nullablerequired

<para type="synopsis">Scheduled Task Location</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsScheduledTask' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "task": "text",
    "location": "text"
  }'

201

401

404

409

No body

Created

Delete

Removes Default Windows Scheduled Task From Optimization.

delete

/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsScheduledTask

Query parameters

siteIdinteger · int32

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

Body

taskstring | nullablerequired

<para type="synopsis">Scheduled Task</para> <para type="description"></para>

locationstring | nullablerequired

<para type="synopsis">Scheduled Task Location</para> <para type="description"></para>

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url '/api/AVD/DefaultSettings/SingleSession/Optimization/WindowsScheduledTask' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "task": "text",
    "location": "text"
  }'

204

401

404

No body

No Content