General

Get

get

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

Path parameters

idinteger · int32Required

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

Responses

200

Success

application/json; api-version=1.0

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

get

/api/AVD/HostPool/{id}/FSLogix/General

HTTPcURLJavaScriptPython

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

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

Update

put

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

Path parameters

idinteger · int32Required

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

Body

application/json; api-version=1.0

useCleanupInvalidSessionsboolean · nullableOptional

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

cleanupInvalidSessionsstring · enumOptional

Enable State values.

Possible values:

useRoamRecycleBinboolean · nullableOptional

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

roamRecycleBinstring · enumOptional

Enable State values.

Possible values:

useVHDCompactDiskboolean · nullableOptional

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

vhdCompactDiskstring · enumOptional

Enable State values.

Possible values:

useCacheDirectoryboolean · nullableOptional

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

cacheDirectorystring · min: 1 · max: 255 · nullableOptional

Specifies the 'Cache directory'.

useWriteCacheDirectoryboolean · nullableOptional

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

writeCacheDirectorystring · min: 1 · max: 255 · nullableOptional

Specifies the 'Write cache directory'.

useProxyDirectoryboolean · nullableOptional

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

proxyDirectorystring · min: 1 · max: 255 · nullableOptional

Specifies the 'Proxy directory'.

useSilenceACLWarningboolean · nullableOptional

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

silenceACLWarningstring · enumOptional

Enable State values.

Possible values:

logEnabledstring · enumOptional

Log enabled values.

Possible values:

logLevelstring · enumOptional

FSLogix log level values.

Possible values:

logFileKeepingPeriodinteger · int32 · nullableOptional

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

logDirectorystring · min: 1 · max: 255 · nullableOptional

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

robocopyLogPathstring · min: 1 · max: 255 · nullableOptional

Specifies the 'Robocopy log path'.

logSpecificComponentsstring[Flag] · enumOptional

Log specific components values.

Possible values:

Responses

204

No Content

401

Unauthorized

application/json; api-version=1.0

404

Not Found

application/json; api-version=1.0

put

/api/AVD/HostPool/{id}/FSLogix/General

HTTPcURLJavaScriptPython

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

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

No content