Get-SPDataConnectionFile
Returns a data connection file or a collection of data connection files.
Syntax
Default (Default)
Get-SPDataConnectionFile
[[-Identity] <SPDataConnectionFilePipeBind>]
[-AssignmentCollection <SPAssignmentCollection>]
[<CommonParameters>]
Description
The Get-SPDataConnectionFile cmdlet gets a specified data connection file or a collection of data connection files. If the Identity parameter is not specified, the cmdlet returns the collection of data connection files for the farm.
For permissions and the most current information about Windows PowerShell for SharePoint Products, see the online documentation at SharePoint Server Cmdlets.
Examples
EXAMPLE 1
Get-SPDataConnectionFile
This example lists the Identity, DisplayName, and WebAccessible properties ofeach .udcx file.
EXAMPLE 2
C:\PS>"Sample.udcx" | Get-SPDataConnectionFile
This example lists the Identity, DisplayName, and WebAccessible properties of the specified file, named Sample.udcx.
EXAMPLE 3
Get-SPDataConnectionFile | where {$_.Category -eq "Category1"}
This example lists the Identity, DisplayName, and WebAccessible properties of all .udcx files with the specified Category.
Parameters
-AssignmentCollection
Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Manages objects for the purpose of proper disposal. Use of objects, such as SPWeb or SPSite, can use large amounts of memory and use of these objects in Windows PowerShell scripts requires proper memory management. Using the SPAssignment object, you can assign objects to a variable and dispose of the objects after they are needed to free up memory. When SPWeb, SPSite, or SPSiteAdministration objects are used, the objects are automatically disposed of if an assignment collection or the Global parameter is not used.
When the Global parameter is used, all objects are contained in the global store. If objects are not immediately used, or disposed of by using the Stop-SPAssignment command, an out-of-memory scenario can occur.
Parameter properties
| Type: | SPAssignmentCollection |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | Named |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
-Identity
Applicable: SharePoint Server 2010, SharePoint Server 2013, SharePoint Server 2016, SharePoint Server 2019
Specifies the data file connection to get.
The type must be a valid GUID, in form 12345678-90ab-cdef-1234-567890bcdefgh; a valid name of a data connection file (for example, DataConnectionFileName1.udcx); or an instance of a valid SPDataConnectionFile object.
Parameter properties
| Type: | SPDataConnectionFilePipeBind |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
(All)
| Position: | 1 |
| Mandatory: | False |
| Value from pipeline: | True |
| Value from pipeline by property name: | False |
| Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.