SupportDocumentation

VDI Default Settings

Get

get

Retrieve default settings used to configure a RAS Guest Agent.

Query parameters
SiteIdinteger · int32Optional

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

Responses
200

Success

application/json; api-version=1.0
get
/api/VDIDefaultSettings

Update

put

Modify default settings used to configure a desktop VM. For each setting, the cmdlet has a corresponding input parameter. To modify a setting, specify a parameter and its value. Default settings are defined on a site level and are applied to a desktop VM when it is initially added to a site.

Query parameters
SiteIdinteger · int32Optional

Site ID for which to update the VDI Default settings (optional)

Body

Update VDI default settings

autoRemovePersIfNotUsedAfterSecinteger · int32 | nullableOptional

Remove assigned persistent desktop from user if not used (in seconds).

assignmentTypestring · enumOptional

Host Assignment Type

Possible values:
technologystring · enumOptional

User Profile Technology values.

Possible values:
sessionActionstring · enumOptional

Session Action type

Possible values:
performActionstring · enumOptional

Perform Action type

Possible values:
performActionAfterSecinteger · int32 | nullableOptional

Perform action after (in seconds).

isUsersGrantedRDPermissionsboolean | nullableOptional

Grant users RD permission.

groupTypestring · enumOptional

Group types to allow remote desktop access

Possible values:
disconnectActiveSessionAfterinteger · int32 | nullableOptional

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

logoffDisconnectedSessionAfterinteger · int32 | nullableOptional

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

sessionReadinessTimeoutinteger · int32 | nullableOptional

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

allowURLAndMailRedirectionstring · enumOptional

URL and Mail Redirection values.

Possible values:
supportShellURLNamespaceObjectsboolean | nullableOptional

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

dragAndDropModestring · enumOptional

Drag and drop redirection values.

Possible values:
allowRemoteExecboolean | nullableOptional

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

manageRDPTransportProtocolstring · enumOptional

Manage RDP transport protocol.

Possible values:
fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:
fileTransferLocationstring | nullableOptional

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

fileTransferLockLocationboolean | nullableOptional

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

enableDriveRedirectionCacheboolean | nullableOptional

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

printerNameFormatstring · enumOptional

Printer Name Format

Possible values:
removeSessionNumberFromPrinterNameboolean | nullableOptional

Enable or disable the 'Remove session number from printer name' option.

removeClientNameFromPrinterNameboolean | nullableOptional

Enable or disable the 'Remove client name from printer name' option.

Responses
put
/api/VDIDefaultSettings
No content
PreviousWindowsServiceNextAppPackageAssigned

Last updated

Was this helpful?