Single Session

Get

get

Retrieve the Azure Virtaul Desktop Default settings.

Query parameters
SiteIdinteger · int32Optional

Site ID for which to retrieve Azure Virtual Desktop Default settings (optional)

Responses
chevron-right
200

Success

application/json; api-version=1.0
get
/api/AVD/DefaultSettings/SingleSession

Update

put

Update the Azure Virtaul Desktop default settings.

Query parameters
SiteIdinteger · int32Optional

The site id for which to modify the Azure Virtaul Desktop default settings.

Body
technologystring · enumOptional

User Profile Technology values.

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.

allowRemoteExecboolean · nullableOptional

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

allowURLAndMailRedirectionstring · enumOptional

URL and Mail Redirection values.

Possible values:
supportShellURLNamespaceObjectsboolean · nullableOptional

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

manageRDPTransportProtocolstring · enumOptional

Manage RDP transport protocol.

Possible values:
manageRDPShortpathboolean · nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

appMonitorboolean · nullableOptional

Specifies if 'Allow Application Monitoring' option is enabled or disabled.

useRDPShortpathboolean · nullableOptional

Specifies if 'Allow RDP Shortpath' option is enabled or disabled.

useSmallerPortRangeboolean · nullableOptional

Specifies if 'Use Smaller Port' option is enabled or disabled.

minRDPShortpathPortinteger · int32 · nullableOptional

The minimum RDP Shortpath Port.

maxRDPShortpathPortinteger · int32 · nullableOptional

The maximum RDP Shortpath Port.

dragAndDropModestring · enumOptional

Drag and drop redirection values.

Possible values:
fileTransferModestring · enumOptional

File Transfer Control modes.

Possible values:
fileTransferLocationstring · min: 1 · max: 255 · 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.

sessionActionstring · enumOptional

Session Action type

Possible values:
performActionstring · enumOptional

Perform Action type

Possible values:
performActionAfterSecinteger · int32 · nullableOptional

Perform action after (in seconds)

printerNameFormatstring · enumOptional

Printer Name Format

Possible values:
removeSessionNumberFromPrinterNameboolean · nullableOptional

Specifies if 'Remove session number from printer name' option is enabled or disabled.

removeClientNameFromPrinterNameboolean · nullableOptional

Specifies if 'Remove client name from printer name' option is enabled or disabled.

Responses
put
/api/AVD/DefaultSettings/SingleSession

No content

Was this helpful?