Skip to content

Get UdeConnection

FH-Inway edited this page Sep 17, 2026 · 1 revision

external help file: d365bap.tools-help.xml Module Name: d365bap.tools online version: schema: 2.0.0

Get-UdeConnection

SYNOPSIS

Retrieves the UDE connection information.

SYNTAX

Get-UdeConnection [[-Path] <String>] [-AsExcelOutput] [-ProgressAction <ActionPreference>] [<CommonParameters>]

DESCRIPTION

This function retrieves the connection information that is currently used by Visual Studio for the User Development Environment (UDE).

EXAMPLES

EXAMPLE 1

Get-UdeConnection

This will retrieve the UDE connection information.

PARAMETERS

-Path

The path to the UDE configuration file.

Defaults to CRMDeveloperToolKit which is the tool used by Visual Studio to communicate with Dynamics 365 / Power Platform environments.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 1
Default value: "$env:APPDATA\Microsoft\CRMDeveloperToolKit"
Accept pipeline input: False
Accept wildcard characters: False

-AsExcelOutput

Instruct the cmdlet to output all details directly to an Excel file.

Will include all properties, including those not shown by default in the console output.

Type: SwitchParameter
Parameter Sets: (All)
Aliases:

Required: False
Position: Named
Default value: False
Accept pipeline input: False
Accept wildcard characters: False

-ProgressAction

{{ Fill ProgressAction Description }}

Type: ActionPreference
Parameter Sets: (All)
Aliases: proga

Required: False
Position: Named
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

Author: Mötz Jensen (@Splaxi)

RELATED LINKS

Clone this wiki locally