Skip to content

Get-ADUserRemoteDesktopSettings

SYNOPSIS

Retrieves Remote Desktop settings for an Active Directory user.

SYNTAX

Get-ADUserRemoteDesktopSettings [-Identity] <String> [[-Credential] <PSCredential>] [<CommonParameters>]

DESCRIPTION

The `Get-ADUserRemoteDesktopSettings` function retrieves Remote Desktop settings for a specified Active Directory user. It includes properties such as `TerminalServicesProfilePath`, `TerminalServicesHomeDirectory`, and `TerminalServicesHomeDrive`. The function supports querying with or without credentials.

EXAMPLES

EXAMPLE 1

Get-ADUserRemoteDesktopSettings -Identity "jdoe"

Retrieves the Remote Desktop settings for the user "jdoe" using the current user's context.

EXAMPLE 2

Get-ADUserRemoteDesktopSettings -Identity "jdoe" -Credential (Get-Credential)

Retrieves the Remote Desktop settings for the user "jdoe" using the specified credentials.

PARAMETERS

-Identity

The identity of the Active Directory user (e.g., DistinguishedName or SamAccountName).

Type: String
Parameter Sets: (All)
Aliases: DN, DistinguishedName

Required: True
Position: 1
Default value: None
Accept pipeline input: True (ByPropertyName, ByValue)
Accept wildcard characters: False

-Credential

The credential to use for querying the Active Directory user. If not specified, the current user's context is used.

Type: PSCredential
Parameter Sets: (All)
Aliases:

Required: False
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

NOTES